Download a report as PDF

GET

/api/v1/reports/{id}/pdf

Docs menu

The report as application/pdf. Until the PDF is ready the answer is 409 pdf_not_ready. If no PDF renderer is installed, pdf.status reads unavailable and the share page can be printed to PDF from any browser.

Key
Bearer key, test or live
Scope
read

Parameters

idstringrequired

The id of the report.

Response

200. The PDF file.

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
not_found404No such object.
pdf_not_ready409The PDF is not ready yet.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode

Download a report as PDF (GET /reports/{id}/pdf) · Docs · PressProve