Schema2020-08-27object

reporting.report_run

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](https://stripe.com/docs/reporting/statements/api). 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](https://stripe.com/docs/keys#test-live-modes).

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

FinancialReportingFinanceReportRunRunParameters

object

columns array

optional

The set of output columns requested for inclusion in the report run.

connected_account string

optional

Connected account ID by which to filter the report run.

maxLength:5000

currency string

optional

Currency of objects to be included in the report run.

interval_end integer (unix-time)

optional

Ending timestamp of data to be included in the report run (exclusive).

interval_start integer (unix-time)

optional

Starting timestamp of data to be included in the report run.

payout string

optional

Payout ID by which to filter the report run.

maxLength:5000

reporting_category string

optional

Category of balance transactions to be included in the report run.

maxLength:5000

timezone string

optional

Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.

maxLength:5000

Root JSON Schema

{"description":"The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).","properties":{"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"error":{"description":"If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).","maxLength":5000,"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"`true` if the report is run on live mode data and `false` if it is run on test mode data.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["reporting.report_run"],"type":"string"},"parameters":{"$ref":"#/components/schemas/financial_reporting_finance_report_run_run_parameters"},"report_type":{"description":"The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`.","maxLength":5000,"type":"string"},"result":{"anyOf":[{"$ref":"#/components/schemas/file"}],"description":"The file object representing the result of the report run (populated when\n `status=succeeded`).","nullable":true},"status":{"description":"Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.","maxLength":5000,"type":"string"},"succeeded_at":{"description":"Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.","format":"unix-time","nullable":true,"type":"integer"}},"required":["created","id","livemode","object","parameters","report_type","status"],"title":"reporting_report_run","type":"object","x-expandableFields":["parameters","result"],"x-resourceId":"reporting.report_run"}