Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Ìfàṣẹ́pọ̀
Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
campaignId (path) | string | Bẹẹni | — |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
id | string | Bẹẹni | — |
org_id | string | Bẹẹni | — |
name | string | Bẹẹni | — |
template_id | string | Bẹẹni | — |
segment_id | string | Bẹẹkọ | — |
purpose | string<marketing, transactional> | Bẹẹni | — |
channels | string[] | Bẹẹni | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Bẹẹni | — |
scheduled_for | string | Bẹẹkọ | — |
include_not_in_good_standing | boolean | Bẹẹkọ | — |
total_recipients | integer | Bẹẹni | — |
skipped | CampaignSkipCounts | Bẹẹni | ⛔ 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 these,… |
delivery | CampaignDeliveryCounts | Bẹẹkọ | ⛔ 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 | Bẹẹkọ | — |
created_at | string | Bẹẹni | — |
started_at | string | Bẹẹkọ | — |
finished_at | string | Bẹẹkọ | — |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404