Retrieve a Report Run

Retrieves the details of an existing Report Run.

get/v1/reporting/report_runs/{report_run}

Path parameters

report_runstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

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

Changed in 9 of the 51 revisions of this API.161624

Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property /////////////// became optional for the status
  response-property-became-optional
- ▲
  the response property //////////// became optional for the status
  response-property-became-optional
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Dec 14, 202446de5407335916See the full diff
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2024d8ab202758612See the full diff
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Oct 23, 202433103c93fb8c14See the full diff
- ▲
  the ///////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////// response's property type changed from no type to object for status
  response-property-type-changed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history