Report Runs

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Was this section helpful? Yes No

Create a Report Run

POST / v1 / reporting / report_runs

Retrieve a Report Run

GET / v1 / reporting / report_runs /:id

List all Report Runs

GET / v1 / reporting / report_runs

The Report Run object

Attributes

id string Unique identifier for the object.
parameters object Parameters of this report run.
report _ type string The ID of the report type to run, such as "balance.summary.1".
result nullable object The file object representing the result of the report run (populated when status=succeeded).
status string 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.

More attributes

object string, value is "reporting.report_run"
created timestamp
error nullable string
livemode boolean
succeeded _ at nullable timestamp

The Report Run object

{ "id": "frr_1MrQwrLkdIwHu7ixUov4x2b3", "object": "reporting.report_run", "created": 1680203749, "error": null, "livemode": false, "parameters": { "interval_end": 1680100000, "interval_start": 1680000000 }, "report_type": "balance.summary.1", "result": null, "status": "pending", "succeeded_at": null}

Create a Report Run

POST / v1 / reporting / report_runs

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

Parameters

report _ type string Required The ID of the report type to run, such as "balance.summary.1".
parameters object Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the API Access to Reports documentation.

Returns

Returns the new ReportRun object.

Response

{ "id": "frr_1MrQwrLkdIwHu7ixUov4x2b3", "object": "reporting.report_run", "created": 1680203749, "error": null, "livemode": false, "parameters": { "interval_end": 1680100000, "interval_start": 1680000000 }, "report_type": "balance.summary.1", "result": null, "status": "pending", "succeeded_at": null}