bird email stats by-location
Usage
Contoh kode
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
Contoh kode
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 (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. |
| --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 | Bounces by SMTP error code |
| bird email stats by-broadcast | Stats by broadcast |
| bird email stats by-category | Stats by category |
| bird email stats by-client | Engagement by email client |
| bird email stats by-complaint-type | Complaints by type |
| bird email stats by-mailbox-provider | Stats by mailbox provider |
| bird email stats by-mailbox-provider-region | Stats by mailbox provider region |
| bird email stats by-recipient-domain | Stats by recipient domain |
| bird email stats by-sending-domain | Stats by sending domain |
| bird email stats by-sending-ip | Stats by sending IP |
| bird email stats by-tag | Stats by tag |
| bird email stats by-template | Stats by template |
| bird email stats daily | Daily sending statistics |
| bird email stats hourly | Hourly sending statistics |
| bird email stats summary | Aggregate stats summary |