Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
ການພິສູດຕົວຕົນ
ສົ່ງ API key ເປັນ bearer token. ຈຸດເຊື່ອມຕໍ່ (endpoint) ນີ້ບໍ່ໄດ້ລະບຸສິດອະນຸຍາດສະເພາະໃດໜຶ່ງໃນຂໍ້ກຳນົດ, ດັ່ງນັ້ນຈຶ່ງຄວນໃຫ້ສິດ key ຂອງທ່ານເທົ່າທີ່ຈຳເປັນໜ້ອຍທີ່ສຸດ ແລະ ກວດສອບການຕອບກັບ ໂດຍບໍ່ຄວນທາດເດົາເອົາເອງ.
ຈຸດເຊື່ອມຕໍ່ນີ້ບໍ່ໄດ້ຮັບ ID ອົງກອນ. ລະຫັດຂອງທ່ານໄດ້ລະບຸອົງກອນທີ່ມັນຂຶ້ນກັບແລ້ວ, ແລະ ຄໍາຕອບແມ່ນຖືກຈໍາກັດຂອບເຂດໄວ້ສໍາລັບອົງກອນນັ້ນ.
ລອງໃຊ້ເບິ່ງ
ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.
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