Stats by mailbox provider region
GET
/v1/email/stats/mailbox-provider-regions
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"const { 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";
}Returns delivery, engagement, and deliverability counts grouped by mailbox provider and provider region pair, for example gmail in NA or microsoft in EU. The provider region is the regional pod the receiving mail system reports for the recipient's provider; pairing it with the provider disambiguates a region label that several providers share. Use this 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 known only once the receiving mail system reports an outcome, so rows cover the delivery stage onward: accepted, processed, and rejected counts and processing latency are not included. Rows are computed against event time (not send time).
Rows are ranked by the sort metric (default delivered) descending and capped at the requested limit (default 50, hard maximum 200). The maximum window is 365 days; requesting a longer range returns 422.
Query पैरामीटर
from
string
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 29 days before to, keeping the defaulted window within the 720-hour trend cap.
to
string
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.
timezone
string
IANA timezone identifier (for example Asia/Kathmandu) to report in; defaults to UTC. Day and hour boundaries and the default window when from and to are omitted both follow it, so a calendar-day from or to names a local day. A from or to carrying its own UTC offset is rejected while this is set: pass a calendar day or a Z instant.
category
string
Not 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.
sort
string
Metric to rank rows by, applied descending. Any count or rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. 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
limit
integer
Maximum number of provider-region rows to return, ranked by the sort field descending.
include_trend
boolean
When true, each row also carries a trend array: a short per-bucket series of that provider region's delivery and engagement rates 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. When from is omitted and trend_grain=hourly, the default window is 30 days (720 hours), so a request built entirely from defaults always fits the cap.
trend_grain
string
Bucket grain for the trend series. Has no effect unless include_trend=true.
Possible values: daily, hourly
Response Payload
period
object
आवश्यक
The date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
चाइल्ड एट्रिब्यूट दिखाएँ
period.from
string
आवश्यक
Inclusive start date the response covers (YYYY-MM-DD).
period.to
string
आवश्यक
Inclusive end date the response covers (YYYY-MM-DD).
period.data_as_of
nullable string
The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
data
array of object
आवश्यक
Provider-region breakdown rows, ranked by the sort metric (default delivered) descending. Empty when no deliveries occurred in the period.
चाइल्ड एट्रिब्यूट दिखाएँ
data.mailbox_provider
string
आवश्यक
The recipient mailbox provider this row aggregates, as a lowercased classifier bucket (e.g. gmail, yahoo, microsoft, apple).
data.mailbox_provider_region
string
आवश्यक
The 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.delivery
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.delivery.delivered
integer
आवश्यक
Distinct recipients whose message the receiving mail server accepted.
data.delivery.bounced
integer
आवश्यक
Distinct recipients whose delivery failed. Approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined); the totals are computed independently so they may differ slightly at the approximation error.
data.delivery.complained
integer
आवश्यक
Distinct recipients who reported the message as spam.
data.delivery.deferred
integer
आवश्यक
Distinct recipients in transient delivery deferral that is still being retried.
data.delivery.bounces
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.delivery.bounces.hard
integer
आवश्यक
Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).
data.delivery.bounces.soft
integer
आवश्यक
Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).
data.delivery.bounces.admin
integer
आवश्यक
Distinct recipients bounced by an upstream policy block (relaying denied, blocklisted domain).
data.delivery.bounces.block
integer
आवश्यक
Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.
data.delivery.bounces.undetermined
integer
आवश्यक
Distinct recipients bounced where the receiving server's response did not allow precise classification.
data.delivery.bounces.hard_rate
nullable number
आवश्यक
Fraction of bounced recipients that hard bounced, computed as hard / bounced. Null when bounced is zero.
data.delivery.bounces.soft_rate
nullable number
आवश्यक
Fraction of bounced recipients that soft bounced, computed as soft / bounced. Null when bounced is zero.
data.delivery.bounces.admin_rate
nullable number
आवश्यक
Fraction of bounced recipients that admin bounced, computed as admin / bounced. Null when bounced is zero.
data.delivery.bounces.block_rate
nullable number
आवश्यक
Fraction of bounced recipients that block bounced, computed as block / bounced. Null when bounced is zero.
data.delivery.bounces.undetermined_rate
nullable number
आवश्यक
Fraction of bounced recipients with undetermined classification, computed as undetermined / bounced. Null when bounced is zero.
data.delivery.delivery_rate
nullable number
आवश्यक
Share of attempted recipients on this mailbox provider that were delivered, computed as delivered / (delivered + bounced). Null when delivered + bounced is zero (no attempts).
data.delivery.bounce_rate
nullable number
आवश्यक
Share of attempted recipients on this mailbox provider that bounced, computed as bounced / (delivered + bounced). Null when delivered + bounced is zero (no attempts).
data.delivery.complaint_rate
nullable number
आवश्यक
Share of delivered recipients on this mailbox provider who reported the message as spam, computed as complained / delivered. Null when delivered is zero.
data.engagement
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.engagement.opens
integer
आवश्यक
Distinct open events, counting repeat opens from the same recipient and opens auto-fetched by inbox privacy features (such as Apple Mail Privacy Protection and the Gmail image proxy).
data.engagement.opens_non_prefetched
integer
आवश्यक
Distinct open events excluding those auto-fetched by inbox privacy features. Same event-counting semantics as opens (repeat opens from the same recipient count separately), with prefetched opens removed.
data.engagement.unique_opens
integer
आवश्यक
Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.
data.engagement.unique_opens_non_prefetched
integer
आवश्यक
Distinct recipients who opened at least once, excluding opens auto-fetched by inbox privacy features. This is the numerator used for open rate, so iOS-heavy audiences (Apple Mail Privacy Protection and similar) do not inflate it.
data.engagement.clicks
integer
आवश्यक
Distinct click events, counting repeat clicks from the same recipient.
data.engagement.unique_clicks
integer
आवश्यक
Distinct recipients who clicked at least once.
data.engagement.unsubscribes
integer
आवश्यक
Distinct unsubscribe events, recorded via the list-unsubscribe header or the footer link.
data.engagement.open_rate
nullable number
आवश्यक
Distinct non-prefetched openers relative to effectively delivered recipients in the same scope, computed as unique_opens_non_prefetched / delivery.effective_delivered; on rows without an effective_delivered field (the mailbox-provider breakdowns) the denominator equals delivery.delivered. The numerator excludes opens auto-fetched by inbox privacy features. Opens are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when the denominator is zero.
data.engagement.click_rate
nullable number
आवश्यक
Distinct clickers relative to effectively delivered recipients in the same scope, computed as unique_clicks / delivery.effective_delivered (delivery.delivered on rows without an effective_delivered field). Clicks are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when the denominator is zero.
data.engagement.unsubscribe_rate
nullable number
आवश्यक
Unsubscribe events relative to effectively delivered recipients in the same scope, computed as unsubscribes / delivery.effective_delivered (delivery.delivered on rows without an effective_delivered field). Unsubscribes are attributed by event time, so the rate can exceed 1. Null when the denominator is zero.
data.latency
object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.delivery
object
आवश्यक
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.delivery.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total
object
आवश्यक
p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.
चाइल्ड एट्रिब्यूट दिखाएँ
data.latency.total.p50_ms
nullable integer
आवश्यक
Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p95_ms
nullable integer
आवश्यक
95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p99_ms
nullable integer
आवश्यक
99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.trend
array of object
Per-bucket rate series for this provider region over the window. Present only when include_trend=true.
चाइल्ड एट्रिब्यूट दिखाएँ
data.trend.bucket
string
आवश्यक
The day (YYYY-MM-DD) or hour (ISO 8601, on the hour) this point covers, matching the requested trend_grain.
data.trend.delivered
integer
आवश्यक
Delivered recipients in this bucket.
data.trend.bounced
integer
आवश्यक
Bounced recipients in this bucket.
data.trend.delivery_rate
nullable number
आवश्यक
Delivery rate for this bucket, as a fraction. Null when nothing was delivered or bounced.
data.trend.bounce_rate
nullable number
आवश्यक
Bounce rate for this bucket, as a fraction. Null when nothing was delivered or bounced.
data.trend.complaint_rate
nullable number
आवश्यक
Complaint rate for this bucket, as a fraction; event-time attribution can push it above 1 when complaints outrun the bucket's deliveries. Null when nothing was delivered in the bucket. On a sending-IP row complaints are not attributed to the IP, so this reads 0 in buckets that had deliveries and null in buckets that had none.
data.trend.open_rate
nullable number
आवश्यक
Open rate for this bucket, as a fraction; event-time attribution can push it above 1 when opens outrun the bucket's deliveries. Null when nothing was delivered in the bucket. On a sending-IP row engagement is not attributed to the IP, so this reads 0 in buckets that had deliveries and null in buckets that had none.
data.trend.click_rate
nullable number
आवश्यक
Click rate for this bucket, as a fraction; event-time attribution can push it above 1 when clicks outrun the bucket's deliveries. Null when nothing was delivered in the bucket. On a sending-IP row engagement is not attributed to the IP, so this reads 0 in buckets that had deliveries and null in buckets that had none.
total
integer
आवश्यक
Total number of distinct mailbox provider and region pairs 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.