Executions

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
definition_idstring · required
triggered_bystring · optional
statusstring · required

one of pending, running, completed, failed

parametersobject · required
localestring · optional

The requester's language, captured when the export is queued. The CSV download and the PDF label columns and enum values in it. Absent for API keys and system runs, whose CSV keeps the snake_case column keys and raw values.

one of pt-MZ, en-US

row_countinteger · required
download_urlstring · optional
error_messagestring · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional
created_atstring (date-time) · required
The object
{
  "id": "rep_2PJiWXxcUzzWiDtIAPJaoNNWqNF",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "definition_id": "def_2dL2WhtIu5Vmo51mWVHA0zjwE3L",
  "triggered_by": "triggered by",
  "status": "pending",
  "parameters": {},
  "locale": "pt-MZ",
  "row_count": 1,
  "download_url": "https://example.org/",
  "error_message": "error message",
  "started_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z"
}

List durable report execution runs

Logs

GET /executions

Returns the tenant's report runs with their definition, status (pending, running, completed or failed), row count, timings, error message and, when completed, the CSV download path. Results are cursor-paginated (default 20, maximum 100); the handler also accepts definition_id and status filters. Requires the reports:read permission.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Report executions

Show attributes
dataarray of ReportExecution · required
Show child attributes
idstring · required
tenant_idstring · required
definition_idstring · required
triggered_bystring · optional
statusstring · required

one of pending, running, completed, failed

parametersobject · required
localestring · optional

The requester's language, captured when the export is queued. The CSV download and the PDF label columns and enum values in it. Absent for API keys and system runs, whose CSV keeps the snake_case column keys and raw values.

one of pt-MZ, en-US

row_countinteger · required
download_urlstring · optional
error_messagestring · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional
created_atstring (date-time) · required
has_moreboolean · optional
next_cursorstring · optional

Errors 403

Permissions reports:read · Roles: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/executions" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "rep_2PJiWXxcUzzWiDtIAPJaoNNWqNF",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "definition_id": "def_2dL2WhtIu5Vmo51mWVHA0zjwE3L",
      "triggered_by": "triggered by",
      "status": "pending",
      "parameters": {},
      "locale": "pt-MZ",
      "row_count": 1,
      "download_url": "https://example.org/",
      "error_message": "error message",
      "started_at": "2026-11-19T09:30:00Z",
      "completed_at": "2026-11-19T09:30:00Z",
      "created_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Trigger report execution

Logs

POST /executions

Requires reports:execute. Execution records are private to their utility tenant.

Body application/json

definition_idstring · required
parametersobject · optional

Returns

202 Report execution started

Show attributes
idstring · required
tenant_idstring · required
definition_idstring · required
triggered_bystring · optional
statusstring · required

one of pending, running, completed, failed

parametersobject · required
localestring · optional

The requester's language, captured when the export is queued. The CSV download and the PDF label columns and enum values in it. Absent for API keys and system runs, whose CSV keeps the snake_case column keys and raw values.

one of pt-MZ, en-US

row_countinteger · required
download_urlstring · optional
error_messagestring · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional
created_atstring (date-time) · required

Errors 403 · 404

Permissions reports:execute · Roles: admin, analyst, finance, owner

curl -X POST "$BUSINESS_API/executions" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "definition_id": "def_2dL2WhtIu5Vmo51mWVHA0zjwE3L",
  "parameters": {}
}'
Response 202
{
  "id": "rep_2PJiWXxcUzzWiDtIAPJaoNNWqNF",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "definition_id": "def_2dL2WhtIu5Vmo51mWVHA0zjwE3L",
  "triggered_by": "triggered by",
  "status": "pending",
  "parameters": {},
  "locale": "pt-MZ",
  "row_count": 1,
  "download_url": "https://example.org/",
  "error_message": "error message",
  "started_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z"
}

Get report execution details

Logs

GET /executions/{id}

Returns one report run, which can be polled until its status is completed or failed. A completed run carries row_count and a download_url for the CSV export; the PDF rendering is available at /exports/{id}.pdf. Returns 404 when the run is not in the tenant. Requires the reports:read permission.

Parameters

idstring · path · required

Identifier of the report execution within the current tenant.

Returns

200 Report execution details

Show attributes
idstring · required
tenant_idstring · required
definition_idstring · required
triggered_bystring · optional
statusstring · required

one of pending, running, completed, failed

parametersobject · required
localestring · optional

The requester's language, captured when the export is queued. The CSV download and the PDF label columns and enum values in it. Absent for API keys and system runs, whose CSV keeps the snake_case column keys and raw values.

one of pt-MZ, en-US

row_countinteger · required
download_urlstring · optional
error_messagestring · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional
created_atstring (date-time) · required

Errors 403 · 404

Permissions reports:read · Roles: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/executions/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "rep_2PJiWXxcUzzWiDtIAPJaoNNWqNF",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "definition_id": "def_2dL2WhtIu5Vmo51mWVHA0zjwE3L",
  "triggered_by": "triggered by",
  "status": "pending",
  "parameters": {},
  "locale": "pt-MZ",
  "row_count": 1,
  "download_url": "https://example.org/",
  "error_message": "error message",
  "started_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z"
}