bird email stats by-mailbox-provider
Usage
Code example
bird email stats by-mailbox-provider [flags]Description
Email delivery and engagement stats grouped by recipient mailbox provider, for example gmail, microsoft, or yahoo. It covers the delivery stage onward and omits accepted or processed counts. For a per-region split within a provider, use bird email stats by-mailbox-provider-region; for exact destination domains instead, use bird email stats by-recipient-domain.
Examples
Code example
bird email stats by-mailbox-providerOptions
| 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). 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 provider'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 mailbox-provider 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 delivered. processed, rejected, and oob_bounces are not part of this breakdown's rows, so they are not sortable here. Possible values: delivered, bounced, complained, deferred, 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-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 |