Documentation
Sign inGet started

bird email stats by-bounce-code

Usage

Codebeispiel
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. It omits delivered, open, and click counts 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

Codebeispiel
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 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.
--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-broadcastGet statistics by broadcast
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