Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
campaignId (path) | string | Да | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | string | Да | — |
org_id | string | Да | — |
name | string | Да | — |
template_id | string | Да | — |
segment_id | string | Нет | — |
purpose | string<marketing, transactional> | Да | — |
channels | string[] | Да | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Да | — |
scheduled_for | string | Нет | — |
include_not_in_good_standing | boolean | Нет | — |
total_recipients | integer | Да | — |
skipped | CampaignSkipCounts | Да | ⛔ 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 | Нет | ⛔ `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 | Нет | — |
created_at | string | Да | — |
started_at | string | Нет | — |
finished_at | string | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404