Campaigns

GET /v1/campaigns/{campaignId}

One campaign and its delivery report.

모든 Campaigns 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 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