Documentation
Sign inGet started

bird email stats by-bounce-code

Usage

Przykład kodu
bird email stats by-bounce-code [flags]

Description

Bounce counts grouped by the SMTP error code the receiving mail server returned. Each row also breaks the bounce down into its hard, soft, admin, block, and undetermined split. There are no delivered, open, or click counts here, because a bounce code only appears on a bounce event. For bounces broken down by destination instead, use bird email stats by-recipient-domain or bird email stats by-mailbox-provider.

Examples

Przykład kodu
bird email stats by-bounce-code

Options

NameDescription
--categoryNot 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.
--fromStart date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to 30 days before to when omitted.
--limit <n>Maximum number of bounce-code 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. It defaults to bounced. Only the bounce counts are sortable here, because this breakdown has no rate fields. Possible values: bounced, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined.
--timezoneIANA timezone identifier (for example Asia/Kathmandu) to report in; defaults to UTC. Day and hour boundaries and the default window when from and to are omitted both follow it, so a calendar-day from or to names a local day. A from or to carrying its own UTC offset is rejected while this is set: pass a calendar day or a Z instant.
--toEnd date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.
NameDescription
bird email stats by-broadcastStats by broadcast
bird email stats by-categoryStats by category
bird email stats by-clientEngagement by email client
bird email stats by-complaint-typeComplaints by type
bird email stats by-locationEngagement by location
bird email stats by-mailbox-providerStats by mailbox provider
bird email stats by-mailbox-provider-regionStats by mailbox provider region
bird email stats by-recipient-domainStats by recipient domain
bird email stats by-sending-domainStats by sending domain
bird email stats by-sending-ipStats by sending IP
bird email stats by-tagStats by tag
bird email stats by-templateStats by template
bird email stats dailyDaily sending statistics
bird email stats hourlyHourly sending statistics
bird email stats summaryAggregate stats summary