Retrieves the details of an existing Report Run.
Parameters
No parameters.
Returns
Returns the specified ReportRun
object if found, and raises an error otherwise.
{ "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}
Returns a list of Report Runs, with the most recent appearing first.
Parameters
- createdobject
Only return Report Runs that were created during the given date interval.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
Report Runs, starting after the argument starting_
if it is provided. Each entry in the array is a separate ReportRun
object. If no more Report Runs are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/reporting/report_runs", "has_more": false, "data": [ { "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 } ]}
The Report Type resource corresponds to a particular type of report, such as the “Activity summary” or “Itemized payouts” reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.
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.
Report Runs v2
The ReportRun
object represents an instance of a Report
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 the results.
Reports v2
The Report resource represents a customizable report template that provides insights into various aspects of your Stripe integration.