Retrieve a report run

Revenue API

Request

Returns the current state of one report run.

Purpose: Poll a run you submitted until it reaches a final status. Poll every 10 to 30 seconds and stop when status is Available, Error, Terminated or Cancelled.

When to use: After Run a report, to poll until the run reaches a final status, or later to check the outcome of a known run.

Request definition

Parameter	In	Type	Required	Description
`submissionId`	path	integer	Yes	Run identifier (`id` returned by Run a report).
`Zuora-Track-Id`	header	string	No	Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.
`Authorization`	header	string	Yes	`Bearer <access_token>` (Zuora OneID OAuth).

Request body: none.

Response definition

HTTP status	Content type	Response schema
`200`	`application/json`	ReportRun
`400`	`application/json`	SpringError
`401`	`application/json`	GatewayError
`403`	`application/json`	GatewayError
`404`	none	No body
`429`	`application/json`	GatewayError
`500`	`application/json`	ServiceError

ReportRun: One execution (submission) of a report layout.

Field	Type	Required	Description
`id`	integer	No	Submission identifier of the run. Use it as `submissionId` to poll status and download.
`reportId`	integer	No	Identifier of the report that was run.
`layoutId`	integer	No	Identifier of the layout that was run.
`status`	string	No	Current run status. See Report run status values. Allowed: `Submitted`, `Upload Started`, `File Created`, `Available`, `Error`, `Terminated`, `Cancelled`.
`fileName`	string	No	Name of the output file. Populated once the file is produced.
`filterParameters`	string	No	JSON text of the filters stored for the run, after defaults and period macros were resolved. Filters are stored with internal filter keys (`key`), operator (`opr`, omitted for `=`) and values (`val1`, `val2`). Treat the content as informational; its format can change.
`config`	string	No	JSON text of output options: `Show Filters` (Y/N, print the filters in the file) and `Enable Totals` (Y/N, add total rows).
`createdBy`	string	No	User that submitted the run.
`runDate`	string (date-time)	No	Date and time the run was submitted, formatted `yyyy-MM-dd'T'HH:mm:ss`.
`updatedBy`	string	No	User or process that last updated the run.
`updatedAt`	string (date-time)	No	Date and time of the last status change, formatted `yyyy-MM-dd'T'HH:mm:ss`.

Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under Error response schemas in the API overview and in components/schemas.

Response codes: 200, 400, 401, 403, 404, 429, 500. Each response with a body includes worked examples; responses without a body say so.

Security

OneIdOAuth

Path

submissionIdinteger, (int64)required

Run identifier (id returned by Run a report).

Example:482391

Zuora-Track-Idstring

Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.

Example:close-run-2026-09-001

cURL

curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/reports/run/482391 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

Success. The run.

Bodyapplication/json

idinteger, (int64)

Submission identifier of the run. Use it as submissionId to poll status and download.

Example:482391

reportIdinteger, (int32)

Identifier of the report that was run.

Example:10021

layoutIdinteger, (int32)

Identifier of the layout that was run.

Example:3105

statusstring

Current run status. See Report run status values.

Enum:"Submitted""Upload Started""File Created""Available""Error""Terminated""Cancelled"

Example:"Available"

fileNamestring or null

Name of the output file. Populated once the file is produced.

Example:"WF_SUMMARY_482391.csv"

filterParametersstring or null

JSON text of the filters stored for the run, after defaults and period macros were resolved. Filters are stored with internal filter keys (key), operator (opr, omitted for =) and values (val1, val2). Treat the content as informational; its format can change.

Example:"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}"

configstring or null

JSON text of output options: Show Filters (Y/N, print the filters in the file) and Enable Totals (Y/N, add total rows).

Example:"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}"

createdBystring or null

User that submitted the run.

Example:"INTEGRATION.USER"

runDatestring or null, (date-time)

Date and time the run was submitted, formatted yyyy-MM-dd'T'HH:mm:ss.

Example:"2026-10-09T07:15:02"

updatedBystring or null

User or process that last updated the run.

Example:"INTEGRATION.USER"

updatedAtstring or null, (date-time)

Date and time of the last status change, formatted yyyy-MM-dd'T'HH:mm:ss.

Example:"2026-10-09T07:16:40"

Response

{
  "id": 482391,
  "reportId": 10021,
  "layoutId": 3105,
  "status": "Submitted",
  "fileName": null,
  "filterParameters": "{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}",
  "config": "{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}",
  "createdBy": "INTEGRATION.USER",
  "runDate": "2026-10-09T07:15:02",
  "updatedBy": "INTEGRATION.USER",
  "updatedAt": "2026-10-09T07:15:02"
}