Campaigns
GET /v1/campaigns/{campaignId}
One campaign and its delivery report.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/campaigns/{campaignId} \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
One campaign with its full delivery report: how many are queued, sent, delivered, bounced, opened, failed and skipped, and why each skip happened.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
campaignId (path) | string | Có | — |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | string | Có | — |
org_id | string | Có | — |
name | string | Có | — |
template_id | string | Có | — |
segment_id | string | Không | — |
purpose | string<marketing, transactional> | Có | — |
channels | string[] | Có | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Có | — |
scheduled_for | string | Không | — |
include_not_in_good_standing | boolean | Không | — |
total_recipients | integer | Có | — |
skipped | CampaignSkipCounts | Có | ⛔ 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 | Không | ⛔ `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 | Không | — |
created_at | string | Có | — |
started_at | string | Không | — |
finished_at | string | Không | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404