Report builder API
13 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/report-builder/dashboards |
List Dashboards |
POST |
/api/report-builder/dashboards |
Create Dashboard Accepts a JSON body. |
GET |
/api/report-builder/dashboards/{dashboard_id} |
Get Dashboard |
PATCH |
/api/report-builder/dashboards/{dashboard_id} |
Update Dashboard Accepts a JSON body. |
DELETE |
/api/report-builder/dashboards/{dashboard_id} |
Delete Dashboard |
GET |
/api/report-builder/reports |
List Reports Query: module, is_shared. |
POST |
/api/report-builder/reports |
Create Report Accepts a JSON body. |
GET |
/api/report-builder/reports/{report_id} |
Get Report |
PATCH |
/api/report-builder/reports/{report_id} |
Update Report Accepts a JSON body. |
DELETE |
/api/report-builder/reports/{report_id} |
Delete Report |
POST |
/api/report-builder/reports/{report_id}/run |
Run Saved |
POST |
/api/report-builder/run |
Run Adhoc Accepts a JSON body. |
GET |
/api/report-builder/schema |
Report Schema |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.