Get statistics by sending IP
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.
Request
- Base URL: https://us1.platform.bird.com
- URL: https://us1.platform.bird.com/v1/email/stats/sending-ips
- Auth: one of:
- HTTP bearer
- API key in cookie bird_session
Query parameters
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
Cursor 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.
Start 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.
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.
IANA 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.
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.
Metric 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.
Maximum number of IP rows to return, ranked by the sort field descending.
When 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.
Bucket grain for a stats trend series.
Bucket grain for the trend series. Has no effect unless include_trend=true.
Headers
Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.
Response
Per-sending-IP breakdown for the requested period.
Example response
{
"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",
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}Changes
No recorded changes to this operation across all 2 revisions of this API.