Campaigns

GET /v1/campaigns/{campaignId}

One campaign and its delivery report.

ټول Campaigns پای ټکي

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
  -H "Authorization: Bearer zdk_live_…"

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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