Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
campaignId (path) | string | Da | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | string | Da | — |
org_id | string | Da | — |
name | string | Da | — |
template_id | string | Da | — |
segment_id | string | Nu | — |
purpose | string<marketing, transactional> | Da | — |
channels | string[] | Da | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Da | — |
scheduled_for | string | Nu | — |
include_not_in_good_standing | boolean | Nu | — |
total_recipients | integer | Da | — |
skipped | CampaignSkipCounts | Da | ⛔ 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 | Nu | ⛔ `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 | Nu | — |
created_at | string | Da | — |
started_at | string | Nu | — |
finished_at | string | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404