bird sms stats by-tag
Usage
Przykład kodu
bird sms stats by-tag [flags]Description
SMS delivery and latency stats grouped by tag (name:value), ranked by the sort metric (default accepted) and capped by limit (default 50, maximum 200). Only tagged messages appear, and one carrying several tags counts once under each, so rows do not sum to the period total.
Examples
Przykład kodu
bird sms stats by-tagOptions
| Name | Description |
|---|---|
| --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 keep the window within the 720-hour trend cap. |
| --include-trend | When true, each row also carries a trend array: a short per-bucket lifecycle-count series for that row 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. |
| --limit <n> | Maximum number of tag 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 lifecycle count or derived rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. Defaults to accepted. Possible values: accepted, sent, delivered, undelivered, failed, rejected, expired, delivery_rate, failure_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 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 daily | Get daily outbound SMS statistics |
| bird sms stats hourly | Get hourly outbound SMS statistics |
| bird sms stats summary | Get aggregate outbound SMS statistics |