API

一斉配信の統計

一斉配信の成果です。送信、配信、バウンス、スパム報告、失敗したコピーの数と、開封、クリック、登録解除した人数を、合計と `grain` ごとに区切った系列で示します。

GETapi.openemail.uk/broadcasts/{id}/stats

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

GET /broadcasts/{id}/stats

一斉配信の成果です。送信、配信、バウンス、スパム報告、失敗したコピーの数と、開封、クリック、登録解除した人数を、合計と grain ごとに区切った系列で示します。

パラメーター

idstring必須: パス内に指定します。`POST /broadcasts` または `GET /broadcasts` から得た `brd_` ID です。
grainstring: 系列のバケット幅: `minute`、`hour`、`day` のいずれか。既定は `hour` です。
offsetMinutesinteger: バケットを区切る UTC からの東向きのオフセット（分）で、-840 から 840 まで。既定は 0 です。ローカルのタイムゾーンには `-new Date().getTimezoneOffset()` を渡します。

例

emails:read が必要です。

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/stats?grain=day" -H "$AUTH"

レスポンス

{  "object": "broadcast_stats",  "broadcastId": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "grain": "day",  "totals": {    "recipients": 412,    "pending": 0,    "sent": 410,    "delivered": 404,    "bounced": 4,    "complained": 1,    "failed": 2,    "opened": 187,    "clicked": 52,    "unsubscribed": 3,    "opens": 296,    "clicks": 71  },  "series": [    { "bucket": "2026-09-23", "delivered": 404, "opened": 161, "clicked": 45, "unsubscribed": 3 },    { "bucket": "2026-09-24", "delivered": 0, "opened": 26, "clicked": 7, "unsubscribed": 0 }  ]}

opened、clicked、unsubscribed は人数を数え、opens と clicks はイベント数を数えます。pending はまだキューにある、予約済み、または送信中のコピーを、failed は失敗またはキャンセルされたコピーを数えます。

series は疎で古い順です。何かが起きた grain ごとに 1 つのバケットがあります。各人はそれが初めて起きた時点で 1 回だけ数えられるため、合計と一致します。

bucket は指定したオフセットでの YYYY-MM-DD、YYYY-MM-DDTHH、YYYY-MM-DDTHH:MM のいずれかです。

拒否

ステータス	コード	発生条件
400	`invalid_cursor`	受信者一覧で、その一覧が渡していない `cursor` が指定された場合。
403	`insufficient_scope`	キーが `emails:read` を持っていません。
404	`broadcast_not_found`	id がこのワークスペースのどの一斉配信も指していないか、キーが特定のアドレスやドメインに限定されていて、その一斉配信がキーの持たないアドレスから送られています。
404	`recipient_not_found`	`GET /broadcasts/{id}/recipients/{emailId}` で、この一斉配信のコピーではない `emailId` が指定された場合。