bird email stats by-location
Usage
Code example
bird email stats by-location [flags]Description
Opens and clicks grouped by country, region, or city, whichever you choose with group_by. It only has engagement counts, no delivery counts or rates. For engagement grouped by mail client or device instead, use bird email stats by-client.
Examples
Code example
bird email stats by-locationOptions
| 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 | Location granularity for each row. country (default) groups by country; region groups by region within country; city groups by city within region. Each row reports the location hierarchy down to the chosen level. Possible values: country, region, city. |
| --limit <n> | Maximum number of location rows to return, ranked by the sort field descending. |
| --response-schema | Print the fields this command returns, then exit |
| --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. |
| --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. |
Related
| 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-client | Get engagement by email client |
| bird email stats by-complaint-type | Get complaints by type |
| 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 summary | Get aggregate email statistics |