Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.
Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
campaignId (path) | string | Ndiyo | — |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
id | string | Ndiyo | — |
org_id | string | Ndiyo | — |
name | string | Ndiyo | — |
template_id | string | Ndiyo | — |
segment_id | string | Hapana | — |
purpose | string<marketing, transactional> | Ndiyo | — |
channels | string[] | Ndiyo | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ndiyo | — |
scheduled_for | string | Hapana | — |
include_not_in_good_standing | boolean | Hapana | — |
total_recipients | integer | Ndiyo | — |
skipped | CampaignSkipCounts | Ndiyo | ⛔ 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 | Hapana | ⛔ `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 | Hapana | — |
created_at | string | Ndiyo | — |
started_at | string | Hapana | — |
finished_at | string | Hapana | — |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404