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}
Retrieve a Report Run
GET / v1 / reporting / report_runs /:id
Retrieves the details of an existing Report Run.
Parameters
No parameters.
Returns
Returns the specified ReportRun object if found, and raises an error otherwise.
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}
List all Report Runs
GET / v1 / reporting / report_runs
Returns a list of Report Runs, with the most recent appearing first.
Parameters
- created object Only return Report Runs that were created during the given date interval.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit Report Runs, starting after the argument starting_after 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.
Response