Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Autenticación
Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
campaignId (path) | string | Sí | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | string | Sí | — |
org_id | string | Sí | — |
name | string | Sí | — |
template_id | string | Sí | — |
segment_id | string | No | — |
purpose | string<marketing, transactional> | Sí | — |
channels | string[] | Sí | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Sí | — |
scheduled_for | string | No | — |
include_not_in_good_standing | boolean | No | — |
total_recipients | integer | Sí | — |
skipped | CampaignSkipCounts | Sí | ⛔ 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 | No | ⛔ `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 | No | — |
created_at | string | Sí | — |
started_at | string | No | — |
finished_at | string | No | — |
Errores que este endpoint puede devolver
401 · 403 · 404