Retrieve report run details

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.

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.

Use this link to download report file. Not available, until status is completed.