一斉配信の分析
現在までの期間に送られた一斉配信の成果を、合計と日、時間、分ごとの集計で示し、比較できるよう一斉配信ごとに 1 行を添えます。一斉配信ページの分析タブと同じ内容です。
実際の呼び出しをワークスペースに対して実行します。
GET /broadcasts/analytics
現在までの期間に送られた一斉配信の成果を、合計と日、時間、分ごとの集計で示し、比較できるよう一斉配信ごとに 1 行を添えます。一斉配信ページの分析タブと同じ内容です。
例
emails:read が必要です。すべての一斉配信が対象なら broadcastIds を省略し、絞るならカンマ区切りで最大 50 個指定します。期間は days(1〜1095)か minutes(1〜1576800、両方送った場合はこちらが優先)で、既定は 30 日です。grain は day、hour、minute のいずれかで既定は day、offsetMinutes(-840〜840)は閲覧者の UTC からのずれです。
curl "$OE/broadcasts/analytics?days=30" -H "$AUTH"{ "object": "broadcast_analytics", "since": "2026-08-25T00:00:00.000Z", "until": "2026-09-23T12:00:00.000Z", "grain": "day", "offsetMinutes": 0, "broadcastIds": [], "totals": { "broadcasts": 2, "recipients": 530, "pending": 0, "sent": 527, "delivered": 519, "bounced": 6, "complained": 1, "failed": 3, "opened": 241, "clicked": 66, "unsubscribed": 4, "opens": 377, "clicks": 90 }, "series": [ { "bucket": "2026-09-09", "sent": 117, "delivered": 115, "opened": 54, "clicked": 14, "unsubscribed": 1 }, { "bucket": "2026-09-23", "sent": 410, "delivered": 404, "opened": 187, "clicked": 52, "unsubscribed": 3 } ], "broadcasts": [ { "id": "brd_5a8c1e3f7b2d94a06c8e1f3b", "subject": "The September release is out", "status": "sent", "sentAt": "2026-09-23T12:00:00.000Z", "recipients": 412, "sent": 410, "delivered": 404, "opened": 187, "clicked": 52, "unsubscribed": 3 }, { "id": "brd_2e7d9b4c1a8f60e35d2c7b91", "subject": "What changed in August", "status": "sent", "sentAt": "2026-09-09T09:30:00.000Z", "recipients": 118, "sent": 117, "delivered": 115, "opened": 54, "clicked": 14, "unsubscribed": 1 } ]}コピーは期間内に送信されたときに数えられ、その後にそのコピーで起きたことはすべて一緒に数えられます。テストモードの一斉配信は含まれません。
totals と series は broadcastIds に含まれる一斉配信を合計し、空ならすべてを合計します。broadcasts は常に期間内のすべての一斉配信を新しい順に、totals と同じ数値付きで一覧にします(ここでは省略しています)。比較や ID 選びに使えます。
opened、clicked、unsubscribed は人数を数え、opens と clicks はイベント数を数えます。series は疎で古い順に並び、各人を最初にそれが起きた時点で 1 回だけ数えます。
ID が 50 個を超えると 422 invalid_parameter になり、期間内にコピーがない ID は何も加えません。特定のアドレスやドメインに限定されたキーは、自分が持つアドレスかドメインから送られた一斉配信だけを読み取ります。
