Documentation
Sign inGet started

bird email stats by-complaint-type

Usage

Esempio di codice
bird email stats by-complaint-type [flags]

Description

Spam-complaint counts grouped by the feedback-loop complaint type (for example abuse, fraud, virus); complaint side only. For complaints by destination use email_stats_by_mailbox_provider or email_stats_by_recipient_domain.

Examples

Esempio di codice
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. Defaults to complained, the only sortable metric for this breakdown.
--timezoneIANA timezone identifier (for example Asia/Kathmandu or America/New_York) to report the statistics in. It is the single source of timezone: day and hour boundaries, and the relative window defaults used when from and to are omitted, are computed in this timezone instead of UTC, so a timezone with a sub-hour offset (such as India at +05:30 or Nepal at +05:45) still gets correct local-day and local-hour totals. When it is set, a from or to given as a calendar day names a local day in this timezone, and one given as an instant stays an absolute point in time but is rounded down to its hour and bucketed in this timezone (so the hour boundaries are local, not UTC). To avoid specifying the zone twice, a from or to that carries its own numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant instead. Defaults to UTC.
--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-codeBounces by SMTP error code
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-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