Developer documentation

API Documentation

Reference material and integration guides for the Relational Manager API.

Integration Partner Kit

Contents

  • Getting_Started.md
  • openapi.yaml
  • postman_collection.json
  • postman_environment.json
  • Troubleshooting.md
  • Support_Intake_Template.md
  • Changelog.md
  • Status.md

Quick Start

  1. Read Getting_Started.md.
  2. Import postman_collection.json and postman_environment.json into Postman.
  3. Use /v1/score with include_prediction=true if you need SNMP forecast output.

Notes

  • The API returns lens results with question-based indicators; no metric/component details are exposed.
  • Lens results include a weighted aggregate score, question-based scoring_coverage, and an organization-specific traffic_light.
  • Each question includes a lens-specific indicator_name and traffic_light for UI dials, using the parent lens ranges.
  • Question prescriptions prefer configured contributor guidance, then authored low, medium, or high guidance selected from classification.
  • Lens-level prescriptions summarize the highest-weight question guidance according to traffic-light urgency.
  • Traffic-light ranges can be read per lens; updating them requires an API key with org:write.
  • persist=true is temporarily disabled for data privacy protection.