Get outbound SMS statistics by country
/v1/sms/stats/countriesconst stats = await bird.sms.stats.byCountry({
from: "2026-05-01",
to: "2026-05-31",
sort: "delivery_rate",
});
for (const row of stats.data ?? []) {
console.log(row.country, row.delivery);
}stats = client.sms.stats.by_country(from_="2026-05-01", to="2026-05-31", sort="delivery_rate")
for row in stats.data or []:
print(row.country, row.delivery)stats, err := client.Sms.Stats.ByCountry(context.Background(), bird.SmsStatsByCountryParams{
From: time.Now().AddDate(0, -1, 0),
To: time.Now(),
Sort: "delivery_rate", // worst delivery first is Sort plus a read of the tail
})
if err != nil {
log.Fatal(err)
}
for _, row := range *stats.Data {
fmt.Println(*row.Country, *row.Delivery.Accepted, *row.Delivery.DeliveryRate)
}$byCountry = $bird->sms->stats->byCountry([
'from' => '2026-05-01',
'to' => '2026-05-31',
'sort' => 'delivery_rate',
]);
foreach ($byCountry->getData() ?? [] as $row) {
echo $row->getCountry(), ' ', $row->getDelivery()?->getDeliveryRate(), PHP_EOL;
}bird sms stats by-countrycurl -X GET "https://us1.platform.bird.com/v1/sms/stats/countries" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=accepted" \
--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": [
{
"country": "US",
"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": 42
}
Returns aggregate delivery and latency stats grouped by destination country for the requested period. Rows are ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, hard maximum 200). Use this to compare sending performance across the countries you send to.
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. 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
limitintegerMaximum number of country 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.
dataCountry breakdown rows, ranked by the sort metric (default accepted) descending. Empty when no messages were sent in the period.
totalTotal number of distinct destination countries 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.