Get statistics by sending IP
/v1/email/stats/sending-ipsconst { data } = await bird.email.stats.bySendingIp({
from: "2026-05-01",
to: "2026-05-31",
sort: "bounces.block",
limit: 20,
});
for (const row of data) console.log(row.sending_ip, row.delivery.delivered);stats = client.email.stats.by_sending_ip(
from_="2026-05-01", to="2026-05-25", sort="bounces.block",
)
for row in stats.data:
print(row)stats, err := client.Email.Stats.BySendingIP(context.Background(), bird.EmailStatsBySendingIPParams{
Sort: "bounced",
})
if err != nil {
log.Fatal(err)
}
fmt.Println(stats.Data)$stats = $bird->email->stats->bySendingIp([
'from' => '2026-05-01',
'to' => '2026-05-31',
'sort' => 'bounces.block',
'limit' => 20,
]);
foreach ($stats->getData() ?? [] as $row) {
echo $row->getSendingIp(), ' ', $row->getDelivery()?->getDelivered(), "\n";
}bird email stats by-sending-ipcurl -X GET "https://us1.platform.bird.com/v1/email/stats/sending-ips" \
-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": [
{
"sending_ip": "192.0.2.55",
"ip_pool_id": "ipp_01krdgeqcxet5s7t44vh8rt9mg",
"delivery": {
"delivered": 8290,
"bounced": 131,
"complained": 8,
"deferred": 4,
"oob_bounces": 3,
"effective_delivered": 8287,
"all_bounces": 134,
"oob_rate": 0.00036,
"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
},
"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": 6,
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns delivery and deliverability counts for the requested period, grouped by the specific IP address used to send each message. Use it to spot a reputation problem on one IP. Block bounces concentrated on a single IP usually mean that IP's reputation has taken a hit, and sorting by bounces.block puts those IPs first.
A sending IP is only known once the receiving mail server reports an outcome: a delivery, a bounce, a deferral, or a late bounce. So this breakdown starts from the delivery stage onward. Accepted, processed, and rejected counts aren't included at all, and neither are engagement counts or processing latency. Complaints and out-of-band bounces aren't attributed to a sending IP either, so complained and oob_bounces are included but always read 0 here. Bounced, deferred, delivery latency, and total latency are the ones that have real numbers. For workspace-wide figures, use GET /v1/email/stats/daily. Rows are computed against event time rather than send time.
Rows are ranked by the sort field, 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.
Queryparameters
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 IPs by, applied descending. Sorting by bounces.block puts the IPs whose reputation is most likely degraded at the top. A row whose rate is undefined because its denominator is zero sorts last. It defaults to delivered. A sending IP has no engagement, so engagement metrics aren't sortable here, and neither are processed, rejected, or oob_bounces.
Possible values: delivered, bounced, complained, deferred, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined, delivery_rate, bounce_rate, complaint_rate, bounces.hard_rate, bounces.soft_rate, bounces.admin_rate, bounces.block_rate, bounces.undetermined_rate
limitintegerMaximum number of IP 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 IP's delivery rates over the window. A trend point's open and click rates read 0 in a bucket that had deliveries and null in one that had none, because a sending IP has no engagement data. 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
Response Payload
periodThe date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
dataSending-IP breakdown rows, ranked by the sort metric (default delivered) descending. Empty when no per-IP-attributable activity (delivery, bounce, deferral, or late bounce) occurred in the period.
Onderliggende attributen tonen
data.sending_ipThe IP address used to send messages aggregated in this row.
data.ip_pool_idThe dedicated IP pool this address sent through, or null when the messages went through the shared pool. Recorded when each message was sent, so it reflects the pool used at send time even if the IP has since moved between pools or been released.
data.deliverydata.latencydata.trendPer-bucket delivery-rate series for this IP over the window. Present only when include_trend=true. Engagement is not attributed to a sending IP, so each point's open and click rates read 0 in buckets with deliveries and null in buckets without.
Onderliggende attributen tonen
data.trend.bucketThe day (YYYY-MM-DD) or hour (ISO 8601, on the hour) this point covers, matching the requested trend_grain.
data.trend.deliveredDelivered recipients in this bucket.
data.trend.bouncedBounced recipients in this bucket.
data.trend.delivery_rateDelivery rate for this bucket, as a fraction. Null when nothing was delivered or bounced.
data.trend.bounce_rateBounce rate for this bucket, as a fraction. Null when nothing was delivered or bounced.
data.trend.complaint_rateComplaint 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_rateOpen 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_rateClick 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.
totalTotal number of distinct sending IP addresses 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.
Gerelateerde bronnen
Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.