認証
ベアラー トークンとして 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 | はい | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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