Create a report run
Reports module
POST/report-runsreportRuns.create
A run of a report definition. Creates a report run. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability reports.report.export.
- OAuth scopes: reports.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: ReportRunCreate
| Field | Type | Required | Description |
|---|---|---|---|
| report_definition_id | string (uuid) | Yes | Identifier of the report definition. |
| export_format | ExportFormat | Yes | Export file format.Constraints: one of "CSV", "XLSX", "PDF" |
{
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"export_format": "CSV"
}Response 201: ReportRun
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the report run. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| report_definition_id | string (uuid) | Yes | Identifier of the report definition. |
| export_format | ExportFormat | Yes | Export file format.Constraints: one of "CSV", "XLSX", "PDF" |
| run_status | "Queued" | "Running" | "Succeeded" | "Failed" | Yes | Run status. |
| finished_at | string (date-time) | null | Yes | When the run finished. |
| run_for_membership_id | string (uuid) | Yes | Identifier of the membership the run is for. |
| started_at | string (date-time) | null | Yes | When the run started. |
| row_count | integer | null | Yes | Rows in the output.Constraints: range 0 to any |
| unpriced_count | integer | null | Yes | Unpriced inputs left out of the money totals.Constraints: range 0 to any |
| last_error | string | null | Yes | Why the run failed.Constraints: length 1 to 20000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"export_format": "CSV",
"run_status": "Queued",
"finished_at": "2026-10-08T14:30:00Z",
"run_for_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"started_at": "2026-10-08T14:30:00Z",
"row_count": 42,
"unpriced_count": 2,
"last_error": "The source was removed."
}Code samples
curl -X POST "$XOS_BASE_URL/report-runs" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"report_definition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","export_format":"CSV"}'const { data } = await xos.reportRuns.create({
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"export_format": "CSV"
});response = xos.report_runs.create({"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "export_format": "CSV"})xos report-runs create --data '{"report_definition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","export_format":"CSV"}'