Documentation
Sign inGet started

bird email stats by-complaint-type

Usage

Code example
bird email stats by-complaint-type [flags]

Description

Spam-complaint counts grouped by the feedback-loop complaint type, for example abuse, fraud, or virus. This complaint-only breakdown omits delivery and engagement counts. For complaints broken down by destination instead, use bird email stats by-mailbox-provider or bird email stats by-recipient-domain.

Examples

Code example
bird email stats by-complaint-type

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 complaint-type rows to return, ranked by complained descending.
--response-schemaPrint the fields this command returns, then exit
--sortMetric to rank rows by, applied descending. It defaults to complained, the only sortable metric for this breakdown. Possible values: complained.
--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-bounce-codeGet bounces by SMTP error code
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-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