Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
campaignId (path) | string | Ya | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | string | Ya | — |
org_id | string | Ya | — |
name | string | Ya | — |
template_id | string | Ya | — |
segment_id | string | Tidak | — |
purpose | string<marketing, transactional> | Ya | — |
channels | string[] | Ya | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ya | — |
scheduled_for | string | Tidak | — |
include_not_in_good_standing | boolean | Tidak | — |
total_recipients | integer | Ya | — |
skipped | CampaignSkipCounts | Ya | ⛔ 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 | Tidak | ⛔ `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 | Tidak | — |
created_at | string | Ya | — |
started_at | string | Tidak | — |
finished_at | string | Tidak | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404