身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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