bird email stats by-template
Usage
Code example
bird email stats by-template [flags]Description
Email delivery and engagement stats grouped by the template used at send time, keyed by template id (emt_…); only templated sends appear. A single template's trend over time comes from bird email stats daily with its template filter.
Examples
Code example
bird email stats by-templateOptions
| 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 has a trend array: a short per-bucket series of that template'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 start tightens to 29 days before to, keeping the window inside 720 hours, so a request built entirely from defaults always fits the cap. |
| --limit <n> | Maximum number of template 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 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. |
| --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 | 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-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 daily | Get daily sending statistics |
| bird email stats hourly | Get hourly sending statistics |
| bird email stats summary | Get aggregate email statistics |