Skip to content
AM

reporting-api (REST)

Reporting uses REST for report templates, runs, schedules, dashboards, widgets, AI queries, insights, and analytics.

Runtime

PropertyCurrent contract
Production API originhttps://api.reporting.inblack.app
Mounted API base/api/v1/reporting
GraphQLNone
HTTP registrations60 total; 52 authenticated product routes, 2 operational routes, and 5 internal routes

The old guide’s https://reporting.inblack.app/api/v1 base omitted the registered /reporting mount and used the SPA hostname.

Example

Terminal window
curl https://api.reporting.inblack.app/api/v1/reporting/report-templates \
  -H "Authorization: Bearer <token>" \
  -H "X-Tenant-ID: <tenant-id>"

The HTTP route reference lists exact methods and mounted paths for report templates, report runs, schedules, dashboards, widgets, AI queries, insights, and analytics.

Route review notes

  • Source currently registers updates with PUT, not the previously documented blanket PATCH convention.
  • The manual schedule trigger is POST /report-schedules/{scheduleID}/run.
  • POST /report-schedules/run-due is present under the authenticated mounted API; do not classify it as a public scheduler contract without handler-level review.
  • Internal refresh and cleanup routes are excluded from the public reference.
  • Route presence does not establish a quota, timeout, response envelope, or retry guarantee; those require handler and plan-limit evidence.

Agent boundary

Read-heavy reporting and export workflows are valid direct-API use cases. Agents still default to Reporting MCP tools when a typed tool exists, particularly when tenant visibility and provenance matter.