client-reports
POST /v1/client-reports/clients
Add a client, the domains a report covers, who receives it and how often.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу sites.create; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/client-reports/clients \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
⛔ Refused past the clients your plan covers (5 / 25 / 100, plus packs). Empty domains means the report covers everything this account tracks. locale is the CLIENT's language — the report and its e-mail are written in it. Requires sites.create.
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
name | string | Не | — |
brand_id | object | Не | — |
domains | string[] | Не | — |
recipients | string[] | Не | — |
locale | string | Не | The client's language — any enabled language code. |
sections | ClientReportSectionKey[] | Не | — |
contact_name | string | Не | — |
notes | string | Не | Your own notes; never printed. |
cadence | ClientReportCadence | Не | — |
send_email | boolean | Не | — |
active | boolean | Не | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Да | — |
name | string | Да | — |
brand_id | object | Да | — |
domains | string[] | Да | — |
recipients | string[] | Да | — |
locale | string | Да | — |
sections | ClientReportSectionKey[] | Да | — |
contact_name | string | Да | — |
notes | string | Да | — |
cadence | ClientReportCadence | Да | — |
send_email | boolean | Да | — |
active | boolean | Да | — |
next_run_at | object | Да | — |
last_run_at | object | Да | — |
created_at | string | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429