client-reports
POST /v1/client-reports/reports/{report_id}/revoke
Stop the report's share link working, now.
Authentication
Send an API key as a bearer token. The key must carry the sites.create 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 POST https://api.zinndigital.com/v1/client-reports/reports/{report_id}/revoke \
-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
Requires sites.create.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
report_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
client_id | string | Yes | — |
client_name | string | Yes | — |
period_start | string | Yes | — |
period_end | string | Yes | — |
locale | string | Yes | — |
state | string<building, ready, failed> | Yes | — |
source | string<manual, schedule> | Yes | — |
sections | ClientReportSectionKey[] | Yes | — |
headline | ClientReportHeadline[] | Yes | — |
changes | integer | Yes | How many figures moved since the previous report. |
failure | ClientReportFailure | null | Yes | Why a failed report failed, or why a ready one could not be e-mailed. |
share_url | object | Yes | null once revoked or expired. |
share_expires_at | object | Yes | — |
revoked | boolean | Yes | — |
views | integer | Yes | — |
emailed_at | object | Yes | — |
emailed_to | string[] | Yes | — |
created_at | string | Yes | — |
finished_at | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429