bird email stats by-category
Usage
Esempio di codice
bird email stats by-category [flags]Description
Email delivery and engagement stats grouped by category, meaning transactional compared with marketing. Rows are ranked by sort, processed by default. Set include_trend=true to add a per-bucket rate series to each row.
Examples
Esempio di codice
bird email stats by-categoryOptions
| Name | Description |
|---|---|
| --from | Start date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). It defaults to 30 days before to when you leave it out. When include_trend=true and trend_grain=hourly, that default tightens to 29 days before to instead, so the defaulted window still fits inside the 720-hour trend cap. |
| --include-trend | When true, each row also gets a trend array: a short per-bucket series showing that category's delivery and engagement rates over the window. This only works when limit is 50 or fewer and the window is at most 90 days for trend_grain=daily or 720 hours for trend_grain=hourly. Ask for more and you get a 422. When you leave from out and use trend_grain=hourly, the default window tightens to 29 days before to (720 hours total), so a request built entirely from defaults always fits inside the cap. |
| --limit <n> | Maximum number of category 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 can be used. A row whose rate is undefined because its denominator is zero sorts last. It 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-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-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 |