Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
campaignId (path) | string | Evet | — |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | — |
org_id | string | Evet | — |
name | string | Evet | — |
template_id | string | Evet | — |
segment_id | string | Hayır | — |
purpose | string<marketing, transactional> | Evet | — |
channels | string[] | Evet | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Evet | — |
scheduled_for | string | Hayır | — |
include_not_in_good_standing | boolean | Hayır | — |
total_recipients | integer | Evet | — |
skipped | CampaignSkipCounts | Evet | ⛔ 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 | Hayır | ⛔ `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 | Hayır | — |
created_at | string | Evet | — |
started_at | string | Hayır | — |
finished_at | string | Hayır | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404