Documentation
Sign inGet started

bird email stats by-client

Usage

Codevoorbeeld
bird email stats by-client [flags]

Description

Opens and clicks grouped by mail client, operating system, or device type, whichever you choose with group_by. It only has engagement counts, no delivery counts or rates. For engagement grouped by geography instead, use bird email stats by-location.

Examples

Codevoorbeeld
bird email stats by-client

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.
--group-byWhich reading-environment facet to group rows by. email_client (default) groups by mail client; os groups by operating system; device_type groups by device type. Each row populates the chosen facet and leaves the other two null. Possible values: email_client, os, device_type.
--limit <n>Maximum number of client 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 unique_opens. Only engagement counts are sortable. This breakdown has no rates. Possible values: opens, opens_non_prefetched, unique_opens, unique_opens_non_prefetched, clicks, unique_clicks.
--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-bounce-codeBounces by SMTP error code
bird email stats by-broadcastStats by broadcast
bird email stats by-categoryStats by category
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