Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
campaignId (path) | string | Oui | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
org_id | string | Oui | — |
name | string | Oui | — |
template_id | string | Oui | — |
segment_id | string | Non | — |
purpose | string<marketing, transactional> | Oui | — |
channels | string[] | Oui | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Oui | — |
scheduled_for | string | Non | — |
include_not_in_good_standing | boolean | Non | — |
total_recipients | integer | Oui | — |
skipped | CampaignSkipCounts | Oui | ⛔ 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 | Non | ⛔ `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 | Non | — |
created_at | string | Oui | — |
started_at | string | Non | — |
finished_at | string | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404