bird email stats by-client

Usage

Code example

bird email stats by-client [flags]

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.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example

bird email stats by-client
bird email stats by-client | jq -r '.data[].email_client'
bird email stats by-client --limit 50 --starting-after <cursor>

Options

Filters

Name	Description
--category	Not 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.
--from	Start 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-by	Which 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.
--response-schema	Print the fields this command returns, then exit
--timezone	IANA 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.
--to	End 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.

Pagination

Name	Description
--ending-before	Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--limit <n>	Maximum number of client rows to return, ranked by the sort field descending.
--sort	Metric 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.
--starting-after	Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Name	Description
bird email stats by-bounce-code	Get bounces by SMTP error code
bird email stats by-broadcast	Get statistics by broadcast
bird email stats by-category	Get statistics by category
bird email stats by-complaint-type	Get complaints by type
bird email stats by-location	Get engagement by location
bird email stats by-mailbox-provider	Get statistics by mailbox provider
bird email stats by-mailbox-provider-region	Get statistics by mailbox provider region
bird email stats by-recipient-domain	Get statistics by recipient domain
bird email stats by-sending-domain	Get statistics by sending domain
bird email stats by-sending-ip	Get statistics by sending IP
bird email stats by-tag	Get statistics by tag
bird email stats by-template	Get statistics by template
bird email stats daily	Get daily sending statistics
bird email stats hourly	Get hourly sending statistics
bird email stats query	Get selected email metrics
bird email stats summary	Get aggregate email statistics

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptWhat is click-through rate for email and SMS?Explore the capabilityEmail analytics Implementation guideEmail metrics

Get an implementation brief