Report reference

Reports return read-only views and calculations. Some summarize the recorded books; others preview supplied facts or model assumptions. Each page explains the question a report answers, its parameters and date rules, and how to interpret its result. Descriptions, parameter meanings and examples come from the public report catalog; exact request schemas come from OpenAPI.

Run a report through POST /v1/reports, or use the CLI with reports run. Choose the business, unit and date window explicitly when comparing results. Follow the report’s pagination; one page need not contain the entire result.

Fetch GET /v1/reports for the live descriptions and allowed parameters. The public reference grants no access; the authenticated business catalog is authority. OpenAPI does not enumerate report result fields, so inspect returned JSON and use the meaning documented for the particular report.

Agents can read each report’s index.md mirror. See the HTTP reference for transport and errors and the command reference for changes that feed the reports.