Create a Report Run

Changed on

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

post/v1/reporting/report_runs

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/reporting/report_runs
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

report_typestring required

The ID of the report type to run, such as "balance.summary.1".

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

errorstring nullable

If something should go wrong during the run, a message about the failure (populated when status=failed).

idstring required

Unique identifier for the object.

livemodeboolean required

true if the report is run on live mode data and false if it is run on test mode data.

object'reporting.report_run' required

String representing the object's type. Objects of the same type share the same value.

report_typestring required

The ID of the report type to run, such as "balance.summary.1".

statusstring required

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_atinteger nullable

Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.