Get report

🚧

Beta feature

This feature is currently in beta testing, and the final specification may still change.

Retrieve a single report by its ID. Poll this to check on a report you created, and to grab a download link once it's ready.

The download link is pre-signed and freshly generated on every call, and expires 15 minutes after you get it. If it expires before you download the file, just call this endpoint again for a new one. Expiry of the link doesn't affect the report itself.

A report that belongs to another organization gets a 404, same as one that doesn't exist. The same goes for a credential scoped to a single website profile, or a test mode credential. Reports are organization-wide with no live/test distinction, so neither can ever own a real report. That keeps the rule simple: any credential that can't own this report gets a 404, and we never leak whether it exists.

🔑

Access with

Advanced access token with reports.read
Path Params
string
required
^rpt_.+$

Provide the ID of the related report.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/hal+json