Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
campaignId (path) | string | Sim | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | string | Sim | — |
org_id | string | Sim | — |
name | string | Sim | — |
template_id | string | Sim | — |
segment_id | string | Não | — |
purpose | string<marketing, transactional> | Sim | — |
channels | string[] | Sim | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Sim | — |
scheduled_for | string | Não | — |
include_not_in_good_standing | boolean | Não | — |
total_recipients | integer | Sim | — |
skipped | CampaignSkipCounts | Sim | ⛔ 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 | Não | ⛔ `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 | Não | — |
created_at | string | Sim | — |
started_at | string | Não | — |
finished_at | string | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404