Documentation
Sign inGet started

Stats by broadcast

GET
/v1/email/stats/broadcasts
bird email stats by-broadcast
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 capped at 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 422. This breakdown is computed from per-message activity retained for 30 days, so it reflects roughly the last 30 days of activity even when the requested window reaches further back.
Query पैरामीटर
from
string
Start date (inclusive) in YYYY-MM-DD, UTC. Defaults to 30 days before to when omitted.
to
string
End date (inclusive) in YYYY-MM-DD, UTC. Defaults to today (UTC) when omitted. Window may not exceed 365 days.
category
string
Not supported on breakdown endpoints; supplying it returns 422. To compare categories use GET /v1/email/stats/categories; the summary, daily, and hourly statistics accept category as a filter.
sort
string
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
limit
integer
Maximum number of broadcast rows to return, ranked by the sort field descending.
Response Payload
period
object
आवश्यक
The date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
चाइल्ड एट्रिब्यूट दिखाएँ
period.from
string
आवश्यक
Inclusive start date the response covers (YYYY-MM-DD).
period.to
string
आवश्यक
Inclusive end date the response covers (YYYY-MM-DD).
period.data_as_of
nullable string
The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
data
array of object
आवश्यक
Broadcast breakdown rows, ranked by the sort metric (default processed) descending. Empty when no broadcast messages were active in the period.
चाइल्ड एट्रिब्यूट दिखाएँ
data.broadcast_id
string
आवश्यक
The broadcast this row aggregates, the same identifier returned by the broadcast endpoints. Only messages sent as part of a broadcast carry a broadcast identifier; one-off and transactional sends are not included in this breakdown.
data.delivery
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.delivery.accepted
integer
Distinct recipients accepted for delivery after suppression filtering. Reported on time buckets and the period summary; omitted on breakdown rows, whose rollups do not carry it.
data.delivery.processed
integer
आवश्यक
Distinct recipients whose message was processed and handed off for delivery.
data.delivery.delivered
integer
आवश्यक
Distinct recipients whose message the receiving mail server accepted.
data.delivery.bounced
integer
आवश्यक
Distinct recipients whose delivery failed. Approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined); the totals are computed independently so they may differ slightly at the approximation error.
data.delivery.bounces
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.delivery.bounces.hard
integer
आवश्यक
Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).
data.delivery.bounces.soft
integer
आवश्यक
Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).
data.delivery.bounces.admin
integer
आवश्यक
Distinct recipients bounced by an upstream policy block (relaying denied, blocklisted domain).
data.delivery.bounces.block
integer
आवश्यक
Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.
data.delivery.bounces.undetermined
integer
आवश्यक
Distinct recipients bounced where the receiving server's response did not allow precise classification.
data.delivery.bounces.hard_rate
nullable number
आवश्यक
Fraction of bounced recipients that hard bounced, computed as hard / bounced. Null when bounced is zero.
data.delivery.bounces.soft_rate
nullable number
आवश्यक
Fraction of bounced recipients that soft bounced, computed as soft / bounced. Null when bounced is zero.
data.delivery.bounces.admin_rate
nullable number
आवश्यक
Fraction of bounced recipients that admin bounced, computed as admin / bounced. Null when bounced is zero.
data.delivery.bounces.block_rate
nullable number
आवश्यक
Fraction of bounced recipients that block bounced, computed as block / bounced. Null when bounced is zero.
data.delivery.bounces.undetermined_rate
nullable number
आवश्यक
Fraction of bounced recipients with undetermined classification, computed as undetermined / bounced. Null when bounced is zero.
data.delivery.complained
integer
आवश्यक
Distinct recipients who reported the message as spam via a feedback loop.
data.delivery.deferred
integer
आवश्यक
Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.
data.delivery.rejected
integer
आवश्यक
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
आवश्यक
Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. Counted as deduplicated events, not unique recipients.
data.delivery.effective_delivered
integer
आवश्यक
Recipients who remain in-inbox in this scope 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
आवश्यक
Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.
data.delivery.oob_rate
nullable number
आवश्यक
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
आवश्यक
Share of this scope's delivery attempts that resulted in a message remaining in-inbox, computed as effective_delivered / (delivered + bounced). Null when there were no attempts.
data.delivery.bounce_rate
nullable number
आवश्यक
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
आवश्यक
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
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.engagement.opens
integer
आवश्यक
Distinct open events, counting repeat opens from the same recipient and opens auto-fetched by inbox privacy features (such as Apple Mail Privacy Protection and the Gmail image proxy).
data.engagement.opens_non_prefetched
integer
आवश्यक
Distinct open events excluding those auto-fetched by inbox privacy features. Same event-counting semantics as opens (repeat opens from the same recipient count separately), with prefetched opens removed.
data.engagement.unique_opens
integer
आवश्यक
Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
data.engagement.unique_opens_non_prefetched
integer
आवश्यक
Distinct recipients who opened at least once, excluding opens auto-fetched by inbox privacy features. This is the numerator used for open rate, so iOS-heavy audiences (Apple Mail Privacy Protection and similar) do not inflate it.
data.engagement.clicks
integer
आवश्यक
Distinct click events, counting repeat clicks from the same recipient.
data.engagement.unique_clicks
integer
आवश्यक
Distinct recipients who clicked at least once.
data.engagement.unsubscribes
integer
आवश्यक
Distinct unsubscribe events, recorded via the list-unsubscribe header or the footer link.
data.engagement.open_rate
nullable number
आवश्यक
Distinct non-prefetched openers relative to effectively delivered recipients in the same scope, computed as unique_opens_non_prefetched / delivery.effective_delivered; on rows without an effective_delivered field (the mailbox-provider breakdowns) the denominator equals delivery.delivered. The numerator excludes opens auto-fetched by inbox privacy features. Opens are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when the denominator is zero.
data.engagement.click_rate
nullable number
आवश्यक
Distinct clickers relative to effectively delivered recipients in the same scope, computed as unique_clicks / delivery.effective_delivered (delivery.delivered on rows without an effective_delivered field). Clicks are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when the denominator is zero.
data.engagement.unsubscribe_rate
nullable number
आवश्यक
Unsubscribe events relative to effectively delivered recipients in the same scope, computed as unsubscribes / delivery.effective_delivered (delivery.delivered on rows without an effective_delivered field). Unsubscribes are attributed by event time, so the rate can exceed 1. Null when the denominator is zero.
data.latency
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.processing
object
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.processing.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.processing.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.processing.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery
object
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.delivery.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total
object
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.total.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
total
integer
आवश्यक
Total number of distinct broadcasts with activity in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped; raise limit (up to 200) or narrow the window to see more.