Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
campaignId (path) | string | Ja | — |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Ja | — |
org_id | string | Ja | — |
name | string | Ja | — |
template_id | string | Ja | — |
segment_id | string | Nee | — |
purpose | string<marketing, transactional> | Ja | — |
channels | string[] | Ja | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ja | — |
scheduled_for | string | Nee | — |
include_not_in_good_standing | boolean | Nee | — |
total_recipients | integer | Ja | — |
skipped | CampaignSkipCounts | Ja | ⛔ 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 | Nee | ⛔ `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 | Nee | — |
created_at | string | Ja | — |
started_at | string | Nee | — |
finished_at | string | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404