bird email stats summary
Usage
Code example
bird email stats summary [flags]Description
Aggregate email KPIs for one period: sends, delivered, bounces, complaints, opens, clicks, their rates, and latency percentiles. The from and to values are both YYYY-MM-DD days or both RFC 3339 instants (hour grain). Add compare=previous_period for deltas versus the prior window. For a per-day or per-hour series use bird email stats daily or bird email stats hourly.
Examples
Code example
bird email stats summaryOptions
| Name | Description |
|---|---|
| --category | Restrict the statistics to a single category: transactional or marketing. Mutually exclusive with the other dimension filters; only one may be set per request. |
| --compare | Set to previous_period to also include the same statistics for the immediately preceding window of equal length, plus the change between the two, so you can show '+X% vs last period' without a second request. Possible values: previous_period. |
| --from | Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day; an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as to. Defaults to 30 days before to for day windows, or 168 hours (7 days) before to for hour windows, when omitted. |
| --recipient-domain | Restrict the statistics to a single recipient mailbox domain (the part of the recipient address after the @, for example gmail.com). Mutually exclusive with the other dimension filters; only one may be set per request. |
| --response-schema | Print the fields this command returns, then exit |
| --sending-domain | Restrict the statistics to a single sending domain (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request. |
| --sending-ip | Restrict the statistics to a single sending IP. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are 0, and processing latency is null. Complaint, open, and click rates are 0 when deliveries exist and null otherwise. |
| --tag | Restrict the statistics to a single tag. Use name to match any value of a tag, or name:value for a specific pair (for example campaign:spring_launch). Mutually exclusive with the other dimension filters; only one may be set per request. |
| --template | Restricts the statistics to one template, identified by its ID (emt_…) or name. This parameter is mutually exclusive with other dimension filters. |
| --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 | Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day; an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as from. Defaults to today for day windows, or the current hour for hour windows, in that timezone, when omitted. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days). |
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 by-template | Get statistics by template |
| bird email stats daily | Get daily sending statistics |
| bird email stats hourly | Get hourly sending statistics |