API

一斉配信が誰に届くかを数える

何も送らず何も書き込まずに、これらのオーディエンスへの送信の出発点となる数を返します。何人に届くか、配信停止のために何人、アドレスが抑止されているために何人がスキップされるかです。複数のオーディエンスに入っている連絡先は 1 回だけ数えます。

POSTapi.openemail.uk/broadcasts/preview

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

POST /broadcasts/preview

例

audiences:read だけが必要なので、送信できないキーでも誰かに人数を見せられます。audienceIds には 1〜10 個の ID を入れ、本文にはそれ以外受け付けません。

curl

curl -X POST "$OE/broadcasts/preview" -H "$AUTH" -H 'content-type: application/json' -d '{  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71", "aud_7e3d9a1c5b2f84e06d9a3c51"]}'

レスポンス

{  "object": "broadcast_preview",  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71", "aud_7e3d9a1c5b2f84e06d9a3c51"],  "recipients": 412,  "unsubscribed": 9,  "suppressed": 3}

unsubscribed は、これらのオーディエンスのうち自分が入っているすべてで配信停止した連絡先を数えます。どれか 1 つでまだ購読している連絡先は recipients に数えられます。

suppressed は、バウンスや苦情のため、あるいは誰かが追加したために抑止リストにアドレスがある購読中の連絡先を数えます。

数は呼び出し時点のものです。どのオーディエンスも指さない ID は 404 audience_not_found になります。