Campaigns

GET /v1/campaigns/{campaignId}

One campaign and its delivery report.

所有 Campaigns 端点

身份验证

请将 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

响应

名称类型必填内容简介
idstring
org_idstring
namestring
template_idstring
segment_idstring
purposestring<marketing, transactional>
channelsstring[]
statusstring<draft, scheduled, sending, paused, sent, cancelled, failed>
scheduled_forstring
include_not_in_good_standingboolean
total_recipientsinteger
skippedCampaignSkipCounts⛔ 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…
deliveryCampaignDeliveryCounts⛔ `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_errorstring
created_atstring
started_atstring
finished_atstring

此端点可能返回的错误

401 · 403 · 404