Get statistics by broadcast

GET

/v1/email/stats/broadcasts

const { data } = await bird.email.stats.byBroadcast({
  from: "2026-05-01",
  to: "2026-05-31",
  sort: "click_rate",
  limit: 25,
});
for (const row of data) console.log(row.broadcast_id, row.engagement.click_rate);

stats = client.email.stats.by_broadcast(from_="2026-05-01", to="2026-05-25")
for row in stats.data:
    print(row)

stats, err := client.Email.Stats.ByBroadcast(context.Background(), bird.EmailStatsByBroadcastParams{
	Limit: 25,
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(stats.Data)

$stats = $bird->email->stats->byBroadcast([
    'from' => '2026-05-01',
    'to' => '2026-05-31',
    'sort' => 'click_rate',
    'limit' => 25,
]);
foreach ($stats->getData() ?? [] as $row) {
    echo $row->getBroadcastId(), ' ', $row->getEngagement()?->getClickRate(), "\n";
}

bird email stats by-broadcast

curl -X GET "https://us1.platform.bird.com/v1/email/stats/broadcasts" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=processed" \
  --url-query "limit=50"

Respons200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "broadcast_id": "eb_01krdgeqcxet5s7t44vh8rt9mg",
      "delivery": {
        "accepted": 14820,
        "processed": 14810,
        "delivered": 14720,
        "bounced": 90,
        "bounces": {
          "hard": 12410,
          "soft": 14290,
          "admin": 410,
          "block": 920,
          "undetermined": 80,
          "hard_rate": 0.454,
          "soft_rate": 0.523,
          "admin_rate": 0.015,
          "block_rate": 0.0337,
          "undetermined_rate": 0.0029
        },
        "complained": 3,
        "deferred": 14,
        "rejected": 10,
        "oob_bounces": 2,
        "effective_delivered": 14718,
        "all_bounces": 92,
        "oob_rate": 0.00014,
        "delivery_rate": 0.9939,
        "bounce_rate": 0.0061,
        "complaint_rate": 0.0002
      },
      "engagement": {
        "opens": 5420,
        "opens_non_prefetched": 3210,
        "unique_opens": 3640,
        "unique_opens_non_prefetched": 2480,
        "clicks": 924,
        "unique_clicks": 621,
        "unsubscribes": 12,
        "open_rate": 0.1683,
        "click_rate": 0.0422,
        "unsubscribe_rate": 0.0009
      },
      "latency": {
        "processing": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "delivery": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "total": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        }
      }
    }
  ],
  "total": 57,
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns aggregate delivery and engagement counts grouped by broadcast for the requested period, so each broadcast's deliverability and engagement can be compared side by side. Only messages sent as part of a broadcast appear here. One-off and transactional sends are not included, so a workspace that has not sent broadcasts returns an empty list rather than an error.

Rows are ranked by the sort metric (default processed) descending and paginated with the requested limit (default 50, hard maximum 200). Rows are computed against event time (not send time), so engagement received during the period for messages sent earlier is included.

The maximum window is 365 days. Requesting a longer range returns a 422. Aggregate statistics remain available after the underlying message activity details expire. Counts and latency percentiles are approximate and may lag newly received activity; data_as_of reports refresh freshness when available. Historical results include only activity captured before those details expired.

Parameter Kueri

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

fromstring

Start date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (UTC when omitted). Defaults to 30 days before to when omitted.

tostring

End date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (UTC when omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.

timezonestring

IANA timezone identifier used to group statistics, for example Asia/Kathmandu. The default is UTC. Day and hour boundaries, including the default window when from and to are omitted, follow this timezone. When this parameter is set, pass from and to as calendar days or Z instants instead of timestamps with explicit UTC offsets.

categorystring

Not supported on breakdown endpoints. Supplying it returns a 422. To compare categories, use GET /v1/email/stats/categories. The summary, daily, and hourly statistics accept category as a filter.

sortstring

Metric to rank rows by, applied descending. Any count or rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. Defaults to processed.

Possible values: processed, delivered, bounced, complained, deferred, rejected, oob_bounces, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined, opens, opens_non_prefetched, unique_opens, unique_opens_non_prefetched, clicks, unique_clicks, unsubscribes, delivery_rate, bounce_rate, complaint_rate, open_rate, click_rate, unsubscribe_rate, bounces.hard_rate, bounces.soft_rate, bounces.admin_rate, bounces.block_rate, bounces.undetermined_rate

limitinteger

Maximum number of broadcast rows to return, ranked by the sort field descending.

Payload Respons

period

object

wajib

The date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.

Tampilkan atribut turunan

data

array of object

wajib

Broadcast breakdown rows, ranked by the sort metric (default processed) descending. Empty when no broadcast messages were active in the period.

Tampilkan atribut turunan

data.broadcast_id

string

wajib

The broadcast this row covers, the same ID the broadcast endpoints return. Only mail sent as part of a broadcast has a broadcast ID, so one-off and transactional sends do not appear in this breakdown at all.

data.delivery

object

wajib

Tampilkan atribut turunan

data.delivery.accepted

integer

Distinct recipients accepted for delivery after suppression filtering. Reported on time buckets and the period summary. Breakdown rows leave it out, because their rollups do not have it.

data.delivery.processed

integer

wajib

Distinct recipients whose message was processed and handed off for delivery.

data.delivery.delivered

integer

wajib

Distinct recipients whose message the receiving mail server accepted.

data.delivery.bounced

integer

wajib

Distinct recipients whose delivery failed. This is approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined). The two totals are worked out independently, so they can differ slightly.

data.delivery.bounces

object

wajib

Tampilkan atribut turunan

data.delivery.complained

integer

wajib

Distinct recipients who reported the message as spam via a feedback loop.

data.delivery.deferred

integer

wajib

Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.

data.delivery.rejected

integer

wajib

Distinct recipients rejected before any delivery attempt. Includes recipients on the workspace suppression list, transmissions that could not be completed, message-generation failures, and recipients refused by sending policy. The per-recipient rejection_reason field on GET /v1/email/messages/{message_id}/recipients surfaces the specific cause.

data.delivery.oob_bounces

integer

wajib

Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. The count represents deduplicated events rather than unique recipients.

data.delivery.effective_delivered

integer

wajib

Recipients who remain delivered after all bounce signals resolve, computed as delivered - oob_bounces. Use this as the base for engagement-rate denominators. Clamped to 0 when oob_bounces exceeds delivered.

data.delivery.all_bounces

integer

wajib

Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.

data.delivery.oob_rate

nullable number

wajib

Share of this scope's delivery attempts that resulted in an out-of-band bounce, computed as oob_bounces / (delivered + bounced). Null when there were no attempts.

data.delivery.delivery_rate

nullable number

wajib

Share of this scope's delivery attempts that remained delivered after all bounce signals, computed as effective_delivered / (delivered + bounced). Null when there were no attempts.

data.delivery.bounce_rate

nullable number

wajib

Share of this scope's delivery attempts that ultimately failed (inband or out-of-band), computed as all_bounces / (delivered + bounced). Because oob_bounces counts events rather than recipients, all_bounces can exceed the attempt count. The rate is clamped to 1. Null when there were no attempts.

data.delivery.complaint_rate

nullable number

wajib

Spam complaints in this scope relative to effectively delivered recipients, computed as complained / effective_delivered. Complaints are attributed by event time, so a scope can record more of them than it effectively delivered, pushing the rate above 1. Null when effective_delivered is zero.

data.engagement

object

wajib

Tampilkan atribut turunan

data.latency

object

wajib

Tampilkan atribut turunan

total

integer

wajib

Total number of distinct broadcasts with activity in the period, regardless of limit. Pass next_cursor as starting_after to request the next page.

next_cursor

nullable string

wajib

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

wajib

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

wajib

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Dapatkan ringkasan implementasi

const { data } = await bird.email.stats.byBroadcast({
  from: "2026-05-01",
  to: "2026-05-31",
  sort: "click_rate",
  limit: 25,
});
for (const row of data) console.log(row.broadcast_id, row.engagement.click_rate);

stats = client.email.stats.by_broadcast(from_="2026-05-01", to="2026-05-25")
for row in stats.data:
    print(row)

stats, err := client.Email.Stats.ByBroadcast(context.Background(), bird.EmailStatsByBroadcastParams{
	Limit: 25,
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(stats.Data)

$stats = $bird->email->stats->byBroadcast([
    'from' => '2026-05-01',
    'to' => '2026-05-31',
    'sort' => 'click_rate',
    'limit' => 25,
]);
foreach ($stats->getData() ?? [] as $row) {
    echo $row->getBroadcastId(), ' ', $row->getEngagement()?->getClickRate(), "\n";
}

bird email stats by-broadcast

curl -X GET "https://us1.platform.bird.com/v1/email/stats/broadcasts" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=processed" \
  --url-query "limit=50"

Respons200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "broadcast_id": "eb_01krdgeqcxet5s7t44vh8rt9mg",
      "delivery": {
        "accepted": 14820,
        "processed": 14810,
        "delivered": 14720,
        "bounced": 90,
        "bounces": {
          "hard": 12410,
          "soft": 14290,
          "admin": 410,
          "block": 920,
          "undetermined": 80,
          "hard_rate": 0.454,
          "soft_rate": 0.523,
          "admin_rate": 0.015,
          "block_rate": 0.0337,
          "undetermined_rate": 0.0029
        },
        "complained": 3,
        "deferred": 14,
        "rejected": 10,
        "oob_bounces": 2,
        "effective_delivered": 14718,
        "all_bounces": 92,
        "oob_rate": 0.00014,
        "delivery_rate": 0.9939,
        "bounce_rate": 0.0061,
        "complaint_rate": 0.0002
      },
      "engagement": {
        "opens": 5420,
        "opens_non_prefetched": 3210,
        "unique_opens": 3640,
        "unique_opens_non_prefetched": 2480,
        "clicks": 924,
        "unique_clicks": 621,
        "unsubscribes": 12,
        "open_rate": 0.1683,
        "click_rate": 0.0422,
        "unsubscribe_rate": 0.0009
      },
      "latency": {
        "processing": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "delivery": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "total": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        }
      }
    }
  ],
  "total": 57,
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Get statistics by broadcast

Parameter Kueri

Payload Respons

Sumber daya terkait