Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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 | Diperlukan | Apakah ia |
|---|---|---|---|
campaignId (path) | string | Ya | — |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
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 | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404