Sign inGet started

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. Reflects roughly the last 30 days of activity.

Examples

Code example
bird email stats by-broadcast

Options

NameDescription
--categoryNot 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.
--fromStart date (inclusive) in YYYY-MM-DD, UTC. Defaults to 30 days before to when omitted.
--limit <n>Maximum number of broadcast rows to return, ranked by the sort field descending.
--response-schemaPrint the fields this command returns, then exit
--sortMetric 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.
--toEnd date (inclusive) in YYYY-MM-DD, UTC. Defaults to today (UTC) when omitted. Window may not exceed 365 days.
NameDescription
bird email stats by-bounce-codeGet bounces by SMTP error code
bird email stats by-categoryGet statistics by category
bird email stats by-clientGet engagement by email client
bird email stats by-complaint-typeGet complaints by type
bird email stats by-locationGet engagement by location
bird email stats by-mailbox-providerGet statistics by mailbox provider
bird email stats by-mailbox-provider-regionGet statistics by mailbox provider region
bird email stats by-recipient-domainGet statistics by recipient domain
bird email stats by-sending-domainGet statistics by sending domain
bird email stats by-sending-ipGet statistics by sending IP
bird email stats by-tagGet statistics by tag
bird email stats by-templateGet statistics by template
bird email stats dailyGet daily sending statistics
bird email stats hourlyGet hourly sending statistics
bird email stats summaryGet aggregate email statistics

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Get an implementation brief