client-reports
POST /v1/client-reports/reports/{report_id}/revoke
Stop the report's share link working, now.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу sites.create; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/client-reports/reports/{report_id}/revoke \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Requires sites.create.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
report_id (path) | string | Да | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Да | — |
client_id | string | Да | — |
client_name | string | Да | — |
period_start | string | Да | — |
period_end | string | Да | — |
locale | string | Да | — |
state | string<building, ready, failed> | Да | — |
source | string<manual, schedule> | Да | — |
sections | ClientReportSectionKey[] | Да | — |
headline | ClientReportHeadline[] | Да | — |
changes | integer | Да | How many figures moved since the previous report. |
failure | ClientReportFailure | null | Да | Why a failed report failed, or why a ready one could not be e-mailed. |
share_url | object | Да | null once revoked or expired. |
share_expires_at | object | Да | — |
revoked | boolean | Да | — |
views | integer | Да | — |
emailed_at | object | Да | — |
emailed_to | string[] | Да | — |
created_at | string | Да | — |
finished_at | object | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 429