bird email stats summary
Usage
Contoh kode
bird email stats summary [flags]Description
Aggregate email KPIs for one period: sends, delivered, bounces, complaints, opens, clicks, their rates, and latency percentiles. from/to 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 email_stats_daily or email_stats_hourly.
Examples
Contoh kode
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. |
| --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 only assigned once a message reaches delivery, so an IP-filtered result reports delivery-side metrics only: accepted, processed, rejected, complaint, and engagement counts are 0 and the processing latency is null; complaint, open, and click rates read 0 when there were deliveries and null when there were none. |
| --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 | Restrict the statistics to a single template, by its ID (emt_…) or its name. Mutually exclusive with the other dimension filters; only one may be set per request. |
| --timezone | IANA timezone identifier (for example Asia/Kathmandu or America/New_York) to report the statistics in. It is the single source of timezone: day and hour boundaries, and the relative window defaults used when from and to are omitted, are computed in this timezone instead of UTC, so a timezone with a sub-hour offset (such as India at +05:30 or Nepal at +05:45) still gets correct local-day and local-hour totals. When it is set, a from or to given as a calendar day names a local day in this timezone, and one given as an instant stays an absolute point in time but is rounded down to its hour and bucketed in this timezone (so the hour boundaries are local, not UTC). To avoid specifying the zone twice, a from or to that carries its own numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant instead. Defaults to UTC. |
| --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 | 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-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 |