Retrieve a report run

Retrieve details of a report run, based on the report_run_id.

Use this method to check the status of a report run.

If a report run's status is completed, the report file can be downloaded using the file_url for 24 hours after report generation finishes.

Once that 24-hour window elapses, the report run remains retrievable but transitions to expired, and the file can no longer be downloaded.

Request​

Path parameters

Path parameters

Unique ID of the report run.

Header parameters

Header parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

Info

For more information, see: Authentication

Response​

Report run found

Response body

Body object

Unique ID used for accessing report details. Use this to check report generation status.

Possible values: [processing, completed, failed, expired]

Current status of the report run.

Value	Description
processing	Report generation is still in progress.
completed	Report generation finished successfully and the file is available to download for 24 hours via file_url.
failed	Report generation failed and no report file is available.
expired	Report generation previously completed, but the 24-hour file availability window has elapsed and the file can no longer be downloaded.

Use this link to download the report file. Available only when status is completed, and only for 24 hours after report generation finishes.