Sample - Stripe API
GET/v1/reporting/report_runs/{report_run}

Retrieve a Report Run

Retrieves the details of an existing Report Run. Use the returned status to determine whether processing is pending, succeeded, or failed, and inspect result or error when available.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
report_runstringrequired
The unique identifier of the Report Run, limited to 5000 characters.
expandarray<string>optional
Fields to expand in the response.

2 status codes
200Returns the Report Run object with its identifier, report type, parameters, processing status, creation time, live-mode indicator, and any populated result or error details.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
errorstringoptional
If something should go wrong during the run, a message about the failure (populated when `status=failed`).
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
`true` if the report is run on live mode data and `false` if it is run on test mode data.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:reporting.report_run
parametersobjectrequired
report_typestringrequired
The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`.
resultobjectoptional
The file object representing the result of the report run (populated when `status=succeeded`).
statusstringrequired
Status of this report run. This will be `pending` when the run is initially created. When the run finishes, this will be set to `succeeded` and the `result` field will be populated. Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
succeeded_atintegeroptional
Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch.
defaultError response.
errorobjectrequired

Error handling

report_run must identify the Report Run to retrieve and can contain no more than 5000 characters. Use expand to request additional response fields when required.