bird email stats by-broadcast
Usage
Code example
bird email stats by-broadcast [flags]Description
Email delivery and engagement stats grouped by broadcast. Only broadcast sends appear. Aggregate statistics remain available after message activity details expire. For campaigns identified by send-time tags, discover them with bird email stats by-tag and use bird email stats query for filtered reports or complete per-group series; both tools additionally require emails:read. Broadcast IDs and campaign tag values identify different populations. Use activity in the requested period to identify active broadcasts; creation-date filters on a broadcast list cannot establish whether older broadcasts had activity in that period.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird email stats by-broadcast
bird email stats by-broadcast | jq -r '.data[].broadcast_id'
bird email stats by-broadcast --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
--category | 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. |
--from | 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. |
--response-schema | Print the fields this command returns, then exit |
--timezone | 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. |
--to | 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. |
Pagination
| Name | Description |
|---|---|
--ending-before | 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. |
--limit <n> | Maximum number of broadcast rows to return, ranked by the sort field descending. Allowed range: 1 to 200. |
--sort | 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. |
--starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related
| Name | Description |
|---|---|
bird email stats by-bounce-code | Get bounces by SMTP error code |
bird email stats by-category | Get statistics by category |
bird email stats by-client | Get engagement by email client |
bird email stats by-complaint-type | Get complaints by type |
bird email stats by-location | Get engagement by location |
bird email stats by-mailbox-provider | Get statistics by mailbox provider |
bird email stats by-mailbox-provider-region | Get statistics by mailbox provider region |
bird email stats by-recipient-domain | Get statistics by recipient domain |
bird email stats by-sending-domain | Get statistics by sending domain |
bird email stats by-sending-ip | Get statistics by sending IP |
bird email stats by-tag | Get statistics by tag |
bird email stats by-template | Get statistics by template |
bird email stats daily | Get daily sending statistics |
bird email stats hourly | Get hourly sending statistics |
bird email stats query | Query email delivery and engagement metrics |
bird email stats summary | Get aggregate email statistics |
Related resources
Continue with the documentation, guides and examples for this topic.