Get outbound SMS statistics by error code
/v1/sms/stats/error-codesconst stats = await bird.sms.stats.byErrorCode({ from: "2026-05-01", to: "2026-05-31" });
for (const row of stats.data ?? []) {
// The same value as the error_code filter on bird.sms.list.
console.log(row.error_code, row.delivery);
}stats = client.sms.stats.by_error_code(from_="2026-05-01", to="2026-05-31")
for row in stats.data or []:
# The same value as the error_code filter on client.sms.list.
print(row.error_code, row.delivery)stats, err := client.Sms.Stats.ByErrorCode(context.Background(), bird.SmsStatsByErrorCodeParams{
From: time.Now().AddDate(0, -1, 0),
To: time.Now(),
})
if err != nil {
log.Fatal(err)
}
for _, row := range *stats.Data {
// The same value as the error_code filter on Sms.List, so a row joins to its messages.
fmt.Println(*row.ErrorCode, *row.Delivery.Failed)
}$byErrorCode = $bird->sms->stats->byErrorCode(['from' => '2026-05-01', 'to' => '2026-05-31']);
foreach ($byErrorCode->getData() ?? [] as $row) {
// The same value as the error_code filter on $bird->sms->list().
echo $row->getErrorCode(), ' ', $row->getDelivery()?->getFailed(), PHP_EOL;
}bird sms stats by-error-codecurl -X GET "https://us1.platform.bird.com/v1/sms/stats/error-codes" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=failed" \
--url-query "limit=50" \
--url-query "include_trend=false" \
--url-query "trend_grain=daily"{
"period": {
"from": "2026-05-01",
"to": "2026-05-25",
"data_as_of": "2026-05-25T14:03:10Z"
},
"data": [
{
"error_code": "invalid_destination",
"delivery": {
"accepted": 14820,
"sent": 14810,
"delivered": 14720,
"undelivered": 60,
"failed": 25,
"rejected": 10,
"expired": 5,
"delivery_rate": 0.9932,
"failure_rate": 0.0061
},
"latency": {
"processing": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
},
"delivery": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
},
"total": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
}
},
"trend": [
{
"bucket": "2026-05-25",
"delivery": {
"accepted": 14820,
"sent": 14810,
"delivered": 14720,
"undelivered": 60,
"failed": 25,
"rejected": 10,
"expired": 5
}
}
]
}
],
"total": 17
}
Returns aggregate delivery and latency statistics grouped by normalized failure reason for the requested period. The grouping key matches the error_code filter on the message list, so each row maps directly to the affected messages rather than a raw carrier code. Rows are ranked by the sort metric (default failed) descending and capped at the requested limit (default 50, hard maximum 200).
Rows use send-time attribution. A delivery confirmed during the period for a message accepted earlier counts against the earlier period. A recent period therefore under-reports delivered while delivery reports are still arriving, and its counts grow as reports arrive. The maximum window is 365 days; requesting a longer range returns 422.
Paramètres de requête
fromstringStart 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.
tostringEnd 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.
timezonestringIANA 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.
sortstringMetric 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
limitintegerMaximum number of error-code rows to return, ranked by the sort field descending.
include_trendbooleanWhen 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.
trend_grainstringBucket grain for the trend series. Has no effect unless include_trend=true.
Possible values: daily, hourly
Contenu de la réponse
periodThe date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
dataError-code breakdown rows, ranked by the sort metric (default failed) descending. Empty when no delivery failures occurred in the period.
Afficher les attributs enfants
data.error_codeStandardized failure reason this row aggregates. Matches the error_code message-list filter.
data.deliverydata.latencydata.trendPer-bucket lifecycle counts for this error code, using trend_grain. Includes only buckets with activity. Present when include_trend=true.
totalTotal number of distinct error codes with activity in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped; raise limit (up to 200) or narrow the window to see more.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.