Documentation
Sign inGet started

bird sms stats by-error-code

Usage

Codevoorbeeld
bird sms stats by-error-code [flags]

Description

SMS stats grouped by our normalized failure reason, which answers which reasons are driving your failures. The grouping key is the same value as the error_code filter on bird sms list, so a row joins straight to the messages behind it. Ranked by the sort metric (default failed) and capped by limit.

Examples

Codevoorbeeld
bird sms stats by-error-code

Options

NameDescription
--fromStart 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-trendWhen 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 error-code rows to return, ranked by the sort field descending.
--response-schemaPrint the fields this command returns, then exit
--sortMetric to rank rows by, applied descending. Defaults to failed. Only lifecycle counts are sortable; this breakdown has no rates. Possible values: accepted, sent, delivered, undelivered, failed, rejected, expired.
--timezoneIANA 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.
--toEnd 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-grainBucket grain for the trend series. Has no effect unless include_trend=true. Possible values: daily, hourly.
NameDescription
bird sms stats by-carrierGet outbound SMS statistics by carrier
bird sms stats by-categoryGet outbound SMS statistics by category
bird sms stats by-countryGet outbound SMS statistics by country
bird sms stats by-originatorGet outbound SMS statistics by originator
bird sms stats by-statusGet outbound SMS statistics by status
bird sms stats by-tagGet outbound SMS statistics by tag
bird sms stats dailyGet daily outbound SMS statistics
bird sms stats hourlyGet hourly outbound SMS statistics
bird sms stats summaryGet aggregate outbound SMS statistics