client-reports
GET /v1/client-reports/reports/{report_id}/pdf
Download the report as a PDF.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/client-reports/reports/{report_id}/pdf \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
White-label: the document names your agency and never the platform. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
report_id (path) | string | Yes | — |
locale (query) | string | No | Any enabled language; the report's own by default. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503