Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
campaignId (path) | string | Oo | — |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | string | Oo | — |
org_id | string | Oo | — |
name | string | Oo | — |
template_id | string | Oo | — |
segment_id | string | Hindi | — |
purpose | string<marketing, transactional> | Oo | — |
channels | string[] | Oo | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Oo | — |
scheduled_for | string | Hindi | — |
include_not_in_good_standing | boolean | Hindi | — |
total_recipients | integer | Oo | — |
skipped | CampaignSkipCounts | Oo | ⛔ 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 | Hindi | ⛔ `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 | Hindi | — |
created_at | string | Oo | — |
started_at | string | Hindi | — |
finished_at | string | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404