bird sms stats summary
Usage
Codevoorbeeld
bird sms stats summary [flags]Description
Aggregate SMS KPIs for one period: accepted, sent, delivered, undelivered, failed, rejected and expired counts, the derived delivery and failure 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 against the preceding window. For a per-day or per-hour series use bird sms stats daily or bird sms stats hourly.
Examples
Codevoorbeeld
bird sms stats summaryOptions
| Name | Description |
|---|---|
| --carrier | Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (originator, country, category); only one may be set per request. |
| --category | Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (originator, country, carrier); 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. |
| --country | Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (originator, category, carrier); only one may be set per request. |
| --from | Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as to. When omitted, it defaults to 30 days before to for day windows or 168 hours (7 days) before to for hour windows. |
| --originator | Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (country, category, carrier); only one may be set per request. Matches the message from. |
| --response-schema | Print the fields this command returns, then exit |
| --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. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as from. When omitted, it defaults to today for day windows or the current hour for hour windows in that timezone. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days). |
Related
| Name | Description |
|---|---|
| bird sms stats by-carrier | Get outbound SMS statistics by carrier |
| bird sms stats by-category | Get outbound SMS statistics by category |
| bird sms stats by-country | Get outbound SMS statistics by country |
| bird sms stats by-error-code | Get outbound SMS statistics by error code |
| bird sms stats by-originator | Get outbound SMS statistics by originator |
| bird sms stats by-status | Get outbound SMS statistics by status |
| bird sms stats by-tag | Get outbound SMS statistics by tag |
| bird sms stats daily | Get daily outbound SMS statistics |
| bird sms stats hourly | Get hourly outbound SMS statistics |