Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
campaignId (path) | string | Иә | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
id | string | Иә | — |
org_id | string | Иә | — |
name | string | Иә | — |
template_id | string | Иә | — |
segment_id | string | Жоқ | — |
purpose | string<marketing, transactional> | Иә | — |
channels | string[] | Иә | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Иә | — |
scheduled_for | string | Жоқ | — |
include_not_in_good_standing | boolean | Жоқ | — |
total_recipients | integer | Иә | — |
skipped | CampaignSkipCounts | Иә | ⛔ Every skip counted separately and never silent, and **every one is present even when it is zero**. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes… |
delivery | CampaignDeliveryCounts | Жоқ | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
last_error | string | Жоқ | — |
created_at | string | Иә | — |
started_at | string | Жоқ | — |
finished_at | string | Жоқ | — |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 404