campaigns
POST /v1/campaigns/segments/preview
How many people this reaches, who they are, and who it leaves out.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/campaigns/segments/preview \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Pass either a `definition` (to preview an unsaved segment as you build it) or a `segment_id` — exactly one. ⛔ `total` is the TRUE recipient count and `sample` is a bounded illustration of it. They are different numbers and `truncated` says when: an operator who reads the sample size as the audience size sends thousands of emails believing they sent twenty. Every response carries all five skip counters whether or not any is non-zero, because a counter that disappears when it is zero is indistinguishable from a fence that never ran. `skipped_no_marketing_consent` will be large today: marketing is soft opt-in for people who are or were customers, and anyone else needs an explicit opt-in.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | string | いいえ | — |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
definition | CampaignSegmentNode | いいえ | A filter tree. Two node shapes and no third: a GROUP (`op` with `children`) or a CONDITION (`field`/`operator`/`value`). `not` takes exactly one child — an n-ary `not` reads as… |
segment_id | string | いいえ | — |
channel | string | いいえ | — |
purpose | string<marketing, transactional> | いいえ | `marketing` applies the consent fence and the suppression list; `transactional` applies neither — a service notice is not silenced by "stop sending me offers". |
include_not_in_good_standing | boolean | いいえ | ⚖️ Owner ruling 2026-08-26. Suspended and unpaid accounts are excluded by DEFAULT, because a send costs money (CLAUDE.md §2.46). Set this to reach them anyway — which is what a… |
limit | integer | いいえ | — |
record_approval | boolean | いいえ | Persist this resolution as an immutable **approval record** — what the operator saw and agreed to, stamped at the moment they agreed. Returns its id as `snapshot_id`. ⛔ Requires… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
snapshot_id | string | いいえ | The approval record's id when `record_approval` was set; `null` otherwise. |
total | integer | はい | The TRUE recipient count — not the length of `sample`. Show this number, and show the skips beside it. |
skipped_not_in_good_standing | integer | はい | — |
skipped_no_marketing_consent | integer | はい | People the soft opt-in does not cover — a trial that never converted, an imported contact — who hold no explicit opt-in. |
skipped_unsubscribed | integer | はい | — |
skipped_channel_muted | integer | はい | — |
skipped_no_destination | integer | はい | Accounts with no member carrying an address on this channel. |
skipped_total | integer | はい | — |
truncated | boolean | はい | True when `sample` is shorter than `total`. |
evaluated_at | string | はい | — |
scope | string<platform, reseller> | はい | — |
sample | object[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 422