ドキュメント本文へスキップ
API

オーディエンスの増加を読む

現在で終わる期間に、各オーディエンスへ何件の連絡先が参加したかを、日・時間・分単位で数えます。オーディエンスページの増加グラフと同じものです。オーディエンスは誰かが参加した日時を記録し、抜けた日時は記録しないため、どの数値も今日もリストにいる人を参加日で数えたものになり、線が下がることはありません。

GETapi.openemail.uk/audiences/growth

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

GET /audiences/growth

現在で終わる期間に、各オーディエンスへ何件の連絡先が参加したかを、日・時間・分単位で数えます。オーディエンスページの増加グラフと同じものです。オーディエンスは誰かが参加した日時を記録し、抜けた日時は記録しないため、どの数値も今日もリストにいる人を参加日で数えたものになり、線が下がることはありません。

audiences:read が必要です。すべてのオーディエンスが対象なら audienceIds を省略し、絞るならカンマ区切りで最大 50 個指定します。期間は days(1〜1095)か minutes(1〜1576800、両方送った場合はこちらが優先)で、既定は 30 日です。graindayhourminute のいずれかで既定は dayoffsetMinutes(-840〜840)は閲覧者の UTC からのずれで、日単位の区切りが現地の午前 0 時に始まるようにします。

curl
curl "$OE/audiences/growth?days=30" -H "$AUTH"
レスポンス
{  "object": "audience_growth",  "since": "2026-08-25T00:00:00.000Z",  "until": "2026-09-23T12:00:00.000Z",  "grain": "day",  "offsetMinutes": 0,  "totals": {    "contacts": 412,    "memberships": 415,    "added": 37,    "lists": 2,    "busiest": "2026-09-18"  },  "series": [    {      "id": "aud_9f2c4b7e1a0d63d84c5f2e7b",      "name": "All contacts",      "builtin": true,      "total": 412,      "before": 378,      "added": 34,      "buckets": [        { "bucket": "2026-09-14", "added": 9 },        { "bucket": "2026-09-18", "added": 25 }      ]    },    {      "id": "aud_4c1b8e2a7d9f05c36b4e8a71",      "name": "Product updates",      "builtin": false,      "total": 3,      "before": 0,      "added": 3,      "buckets": [{ "bucket": "2026-09-18", "added": 3 }]    }  ]}

total は現在のメンバー、before はそのうち since より前に参加した人、added は期間内に参加した人で、beforeadded の合計が total になります。参加したあとで抜けた連絡先は、どれにも含まれません。

totals.contacts は何個のリストに入っていても各人を 1 回だけ数え、totals.memberships はリストを合計します。そのため、読み取ったリストのうちその人が入っているものの数だけ数えられ、デフォルトオーディエンスには全員が入っています。totals.busiest は全リストを通じて参加が最も多かった区切りで、誰も参加しなければ null です。

区切りのキーは、日単位なら YYYY-MM-DD、時間単位なら YYYY-MM-DDTHH、分単位なら YYYY-MM-DDTHH:MM で、offsetMinutes が示す現地時刻で表されます。参加があった区切りだけが列挙されるので、描画するときは空いたところを 0 で埋めてください。seriestotal の大きい順、次に名前順で並び、builtin はデフォルトオーディエンスで true になります。

audienceIds のうちこのワークスペースのオーディエンスでない ID は 404 audience_not_found になり、ID が 50 個を超えると 422 invalid_parameter になります。期間は最初の区切りの始まりから始まるため、since はちょうど days 日前より少し早くなることがあります。