Get statistics by mailbox provider region
/v1/email/stats/mailbox-provider-regionsconst { data } = await bird.email.stats.byMailboxProviderRegion({
from: "2026-05-01",
to: "2026-05-31",
limit: 25,
});
for (const row of data) console.log(row.mailbox_provider, row.mailbox_provider_region, row.delivery.delivered);stats = client.email.stats.by_mailbox_provider_region(from_="2026-05-01", to="2026-05-25")
for row in stats.data:
print(row)stats, err := client.Email.Stats.ByMailboxProviderRegion(context.Background(), bird.EmailStatsByMailboxProviderRegionParams{})
if err != nil {
log.Fatal(err)
}
fmt.Println(stats.Data)$stats = $bird->email->stats->byMailboxProviderRegion([
'from' => '2026-05-01',
'to' => '2026-05-31',
'limit' => 25,
]);
foreach ($stats->getData() ?? [] as $row) {
echo $row->getMailboxProvider(), ' ', $row->getMailboxProviderRegion(), ' ', $row->getDelivery()?->getDelivered(), "\n";
}bird email stats by-mailbox-provider-regioncurl -X GET "https://us1.platform.bird.com/v1/email/stats/mailbox-provider-regions" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=delivered" \
--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": [
{
"mailbox_provider": "gmail",
"mailbox_provider_region": "NA",
"delivery": {
"delivered": 8290,
"bounced": 131,
"complained": 8,
"deferred": 4,
"bounces": {
"hard": 12410,
"soft": 14290,
"admin": 410,
"block": 920,
"undetermined": 80,
"hard_rate": 0.454,
"soft_rate": 0.523,
"admin_rate": 0.015,
"block_rate": 0.0337,
"undetermined_rate": 0.0029
},
"delivery_rate": 0.9844,
"bounce_rate": 0.0156,
"complaint_rate": 0.00096
},
"engagement": {
"opens": 5420,
"opens_non_prefetched": 3210,
"unique_opens": 3640,
"unique_opens_non_prefetched": 2480,
"clicks": 924,
"unique_clicks": 621,
"unsubscribes": 12,
"open_rate": 0.1683,
"click_rate": 0.0422,
"unsubscribe_rate": 0.0009
},
"latency": {
"delivery": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
},
"total": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
}
},
"trend": [
{
"bucket": "2026-05-12"
}
]
}
],
"total": 31,
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns delivery, engagement, and deliverability counts for the requested period, grouped by mailbox provider and provider region pair, for example gmail in NA or microsoft in EU. The provider region is the regional grouping the receiving mail system reports for the recipient's provider. Pairing it with the provider tells apart a region label that several providers share. Use it to spot a deliverability problem isolated to one provider in one region. For a per-provider view without the region split, use the mailbox-provider breakdown.
A provider region is only known once the receiving mail system reports an outcome, so this breakdown covers the delivery stage onward. Accepted, processed, and rejected counts and processing latency are not included. Rows are computed against event time rather than send time.
Rows are ranked by the sort metric, delivered by default, and paginated with the requested limit (50 by default, 200 at most). The window can span at most 365 days. Ask for more and you get a 422.
Parámetros de consulta
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
fromstringStart date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). It defaults to 30 days before to when you leave it out. When include_trend=true and trend_grain=hourly, that default tightens to 29 days before to instead, so the defaulted window still fits inside 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.
categorystringNot supported on breakdown endpoints. Supplying it returns 422. To compare categories, use GET /v1/email/stats/categories. The summary, daily, and hourly statistics accept category as a filter.
sortstringMetric to rank rows by, applied descending. Any count or rate in the response can be used. A row whose rate is undefined because its denominator is zero sorts last. It defaults to delivered. processed, rejected, and oob_bounces are not part of this breakdown's rows, so they are not sortable here.
Possible values: delivered, bounced, complained, deferred, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined, opens, opens_non_prefetched, unique_opens, unique_opens_non_prefetched, clicks, unique_clicks, unsubscribes, delivery_rate, bounce_rate, complaint_rate, open_rate, click_rate, unsubscribe_rate, bounces.hard_rate, bounces.soft_rate, bounces.admin_rate, bounces.block_rate, bounces.undetermined_rate
limitintegerMaximum number of provider-region rows to return, ranked by the sort field descending.
include_trendbooleanWhen true, each row also gets a trend array: a short per-bucket series showing that provider region's delivery and engagement rates over the window. This only works when limit is 50 or fewer and the window is at most 90 days for trend_grain=daily or 720 hours for trend_grain=hourly. Ask for more and you get a 422. When you leave from out and use trend_grain=hourly, the default window tightens to 29 days before to (720 hours total), so a request built entirely from defaults always fits inside the cap.
trend_grainstringBucket grain for the trend series. Has no effect unless include_trend=true.
Possible values: daily, hourly
Carga de respuesta
periodThe date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
dataProvider-region breakdown rows, ranked by the sort metric (default delivered) descending. Empty when no deliveries occurred in the period.
Mostrar atributos secundarios
data.mailbox_providerThe recipient mailbox provider this row aggregates, as a lowercase classifier such as gmail, yahoo, microsoft, or apple.
data.mailbox_provider_regionThe provider region this row aggregates, as reported by the receiving mail system (for example NA, EU, APAC). The set is open and provider-specific.
data.deliverydata.engagementdata.latencyMostrar atributos secundarios
data.latency.deliveryApproximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.
Mostrar atributos secundarios
data.latency.delivery.p50_msMedian (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p95_ms95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p99_ms99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.totalApproximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.
data.trendPer-bucket rate series for this provider region over the window. Present only when include_trend=true.
totalTotal number of distinct mailbox provider and region pairs with activity in the period, regardless of limit. Pass next_cursor as starting_after to request the next page.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Recursos relacionados
Continúa con la documentación, guías y ejemplos de este tema.