Get a report run
Módulo Reports
GET/report-runs/{id}reportRuns.get
A run of a report definition. Returns one report run with its `ETag`. A report run the caller may not see returns 404.
- Requiere la capacidad reports.report.read.
- Alcances de OAuth: reports.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the report run. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: ReportRun
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the report run. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| report_definition_id | string (uuid) | Sí | Identifier of the report definition. |
| export_format | ExportFormat | Sí | Export file format.Restricciones: one of "CSV", "XLSX", "PDF" |
| run_status | "Queued" | "Running" | "Succeeded" | "Failed" | Sí | Run status. |
| finished_at | string (date-time) | null | Sí | When the run finished. |
| run_for_membership_id | string (uuid) | Sí | Identifier of the membership the run is for. |
| started_at | string (date-time) | null | Sí | When the run started. |
| row_count | integer | null | Sí | Rows in the output.Restricciones: range 0 to any |
| unpriced_count | integer | null | Sí | Unpriced inputs left out of the money totals.Restricciones: range 0 to any |
| last_error | string | null | Sí | Why the run failed.Restricciones: 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."
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/report-runs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.reportRuns.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.report_runs.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos report-runs get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f