client-reports
GET /v1/client-reports/overview
What your Client Reports plan allows, and which report sections have data.
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/overview \
-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
The allowance (clients, reports this month, looks, share-link life, own sender) read from the SAME helper the point of spend asks, so the screen and the refusal cannot disagree. sections_with_data names the sections that would print something today. Requires sites.view.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
allowance | ClientReportAllowance | Yes | — |
sections | ClientReportSectionKey[] | Yes | Every section a report can carry, in print order. |
sections_with_data | ClientReportSectionKey[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429