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"

Odpowiedź200

{
  "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.

Parametry zapytania

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.

Treść odpowiedzi

period

object

wymagane

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

Pokaż atrybuty podrzędne

data

array of object

wymagane

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

Pokaż atrybuty podrzędne

data.broadcast_id

string

wymagane

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

wymagane

Pokaż atrybuty podrzędne

data.engagement

object

wymagane

Pokaż atrybuty podrzędne

data.latency

object

wymagane

Pokaż atrybuty podrzędne

data.latency.processing

object

Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.

Pokaż atrybuty podrzędne

data.latency.delivery

object

Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.

Pokaż atrybuty podrzędne

data.latency.total

object

Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.

Pokaż atrybuty podrzędne

data.latency.total.p50_ms

nullable integer

wymagane

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total.p95_ms

nullable integer

wymagane

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total.p99_ms

nullable integer

wymagane

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

total

integer

wymagane

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

wymagane

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

prev_cursor

nullable string

wymagane

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

refresh_cursor

nullable string

wymagane

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.

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy

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"

Odpowiedź200

{
  "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

Parametry zapytania

Treść odpowiedzi

Powiązane zasoby