bird email stats by-recipient-domain
Usage
Przykład kodu
bird email stats by-recipient-domain [flags]Description
Email delivery and engagement stats grouped by exact recipient mailbox domain (for example gmail.com). Finer-grained than email_stats_by_mailbox_provider, which buckets domains into providers.
Examples
Przykład kodu
bird email stats by-recipient-domainOptions
| 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; with include_trend=true and trend_grain=hourly the default tightens to 29 days before to, keeping the defaulted window within the 720-hour trend cap. |
| --include-trend | When true, each row also carries a trend array: a short per-bucket series of that recipient domain's delivery and engagement rates over the window. Returned only when limit is 50 or fewer and the window is at most 90 days (trend_grain=daily) or 720 hours (trend_grain=hourly); a larger request returns 422. When from is omitted and trend_grain=hourly, the default window is 30 days (720 hours), so a request built entirely from defaults always fits the cap. |
| --limit <n> | Maximum number of recipient-domain 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. Any count or rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. Defaults to processed. Possible values: processed, delivered, bounced, complained, deferred, rejected, oob_bounces, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined, opens, opens_non_prefetched, unique_opens, unique_opens_non_prefetched, clicks, unique_clicks, unsubscribes, delivery_rate, bounce_rate, complaint_rate, open_rate, click_rate, unsubscribe_rate, bounces.hard_rate, bounces.soft_rate, bounces.admin_rate, bounces.block_rate, bounces.undetermined_rate. |
| --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. |
| --trend-grain | Bucket grain for the trend series. Has no effect unless include_trend=true. Possible values: daily, hourly. |
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-location | Engagement by location |
| 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-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 |