---
title: "Get statistics by sending IP"
method: GET
path: "/v1/email/stats/sending-ips"
tags: ["email-stats"]
---

# Get statistics by sending IP

`GET /v1/email/stats/sending-ips`

## 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`

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`.

## Query parameters

- `starting_after` string
- `ending_before` string
- `from` string, date
- `to` string, date
- `timezone` string
- `category` string
- `sort` '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'
- `limit` integer
- `include_trend` boolean
- `trend_grain` 'daily' | 'hourly': Bucket grain for a stats trend series.

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

Per-sending-IP breakdown for the requested period.

- EmailStatsBySendingIpResponse: Per-sending-IP breakdown for the requested period, ranked by the `sort` metric (default `delivered`) descending and paginated with the requested `limit` (default 50, max 200).
  - `period` EmailStatsPeriod, required: The date range this response was actually computed against. Echoed back so clients can render the period without tracking it themselves and so cached responses can be keyed by what was queried.
    - `from` string, date, required: Inclusive start date the response covers (YYYY-MM-DD).
    - `to` string, date, required: Inclusive end date the response covers (YYYY-MM-DD).
    - `data_as_of` string, date-time, nullable: 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 reflects data from up to a few seconds ago. 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` EmailSendingIpStatsPoint[], required: Sending-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.
    - `sending_ip` string, required: The IP address used to send messages aggregated in this row.
    - `ip_pool_id` string
    - `delivery` EmailSendingIpDeliveryStats, required: Delivery counts and rates for messages attributed to a single sending IP. Per-IP results omit `accepted` and `processed` counts. The sending IP becomes known only after a message is delivered, bounced, deferred, or bounced late. Those earlier lifecycle states cannot be attributed to a specific IP. Spam complaints and out-of-band bounce notifications also lack per-IP attribution on this breakdown. The `complained` and `oob_bounces` fields therefore read 0. Their rates read 0 when the denominator is non-zero and null when it is zero. The `effective_delivered` field equals `delivered`, and `all_bounces` equals `bounced`.
      - `delivered` integer, required: Distinct recipients whose message the receiving mail server accepted.
      - `bounced` integer, required: Distinct recipients whose delivery failed. This is approximately the sum of the five `bounces.*` sub-counts (hard, soft, admin, block, undetermined). The two are computed independently, so they can differ slightly.
      - `complained` integer, required: Distinct recipients who reported the message as spam. Complaints are not attributed to a sending IP, so this reads 0 on this breakdown. Read complaint counts from the summary or time-series statistics instead.
      - `deferred` integer, required: Distinct recipients in transient delivery deferral that is still being retried.
      - `oob_bounces` integer, required: Out-of-band bounce events: failure notifications received after the receiving server had initially confirmed delivery. Not attributed to a sending IP on this breakdown, so this reads 0. Workspace-wide out-of-band counts are on the summary and time-series statistics.
      - `effective_delivered` integer, required: Recipients on this IP who remain delivered after all bounce signals resolve, computed as `delivered - oob_bounces`. Clamped to 0 when `oob_bounces` exceeds `delivered`.
      - `all_bounces` integer, required: Total recipients on this IP who did not receive the message, computed as `bounced + oob_bounces`.
      - `oob_rate` number, nullable, required: Share of this IP's delivery attempts that resulted in an out-of-band bounce, computed as `oob_bounces / (delivered + bounced)`. Null when `delivered + bounced` is zero (no attempts).
      - `bounces` EmailBounceStatsWithRates, required: Breakdown of `bounced` by failure type, with each rate as a fraction of `bounced`. Counts are distinct bounced recipients of that type; the five types approximately partition `bounced`, so the five rates sum to roughly 1.0 when `bounced` is non-zero.
        - `hard` integer, required: Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).
        - `soft` integer, required: Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).
        - `admin` integer, required: Distinct recipients refused by a policy at the receiving end, such as relaying denied or a blocklisted domain.
        - `block` integer, required: Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.
        - `undetermined` integer, required: Distinct recipients bounced where the receiving server's response did not allow precise classification.
        - `hard_rate` number, nullable, required: Fraction of bounced recipients that hard bounced, computed as `hard / bounced`. Null when `bounced` is zero.
        - `soft_rate` number, nullable, required: Fraction of bounced recipients that soft bounced, computed as `soft / bounced`. Null when `bounced` is zero.
        - `admin_rate` number, nullable, required: Fraction of bounced recipients that admin bounced, computed as `admin / bounced`. Null when `bounced` is zero.
        - `block_rate` number, nullable, required: Fraction of bounced recipients that block bounced, computed as `block / bounced`. Null when `bounced` is zero.
        - `undetermined_rate` number, nullable, required: Fraction of bounced recipients with undetermined classification, computed as `undetermined / bounced`. Null when `bounced` is zero.
      - `delivery_rate` number, nullable, required: Share of this IP's delivery attempts that remained delivered after all bounce signals, computed as `effective_delivered / (delivered + bounced)`. Null when `delivered + bounced` is zero.
      - `bounce_rate` number, nullable, required: Share of this IP's delivery attempts that ultimately failed (inband or out-of-band), computed as `all_bounces / (delivered + bounced)`. Null when `delivered + bounced` is zero (no attempts).
      - `complaint_rate` number, nullable, required: Share of effectively delivered recipients on this IP who reported the message as spam, computed as `complained / effective_delivered`. Null when `effective_delivered` is zero.
    - `latency` EmailDeliveryLatencyStats, required: Latency percentiles (p50, p95, p99) in milliseconds for the messages in this breakdown row, for breakdowns whose dimension is known only from delivery onward (sending IP, mailbox provider). - `delivery`: Time from handing the message off to the receiving mail server accepting it. Null when no deliveries occurred for this row in the period. - `total`: End-to-end time from accepting the send to delivery. Null when no deliveries occurred for this row in the period. These breakdowns have no `processing` latency family. A message's row identifies which sending IP carried it or which mailbox provider received it. This becomes known only after the receiving mail server reports a delivery, bounce, deferral, or late bounce. The accept-to-processed phase ends before that attribution is known, preventing row-level processing latency. Use `GET /v1/email/stats/daily` for processing-latency percentiles across the whole workspace.
      - `delivery` EmailLatencyQuantiles, required: Approximate 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.
        - `p50_ms` integer, nullable, required: Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
        - `p95_ms` integer, nullable, required: 95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
        - `p99_ms` integer, nullable, required: 99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
      - `total` EmailLatencyQuantiles, required: Approximate 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.
        - `p50_ms` integer, nullable, required: Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
        - `p95_ms` integer, nullable, required: 95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
        - `p99_ms` integer, nullable, required: 99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
    - `trend` EmailStatsSeriesPoint[]: Per-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.
      - `bucket` string, required: The day (YYYY-MM-DD) or hour (ISO 8601, on the hour) this point covers, matching the requested `trend_grain`.
      - `delivered` integer, required: Delivered recipients in this bucket.
      - `bounced` integer, required: Bounced recipients in this bucket.
      - `delivery_rate` number, nullable, required: Delivery rate for this bucket, as a fraction. Null when nothing was delivered or bounced.
      - `bounce_rate` number, nullable, required: Bounce rate for this bucket, as a fraction. Null when nothing was delivered or bounced.
      - `complaint_rate` number, nullable, required: 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.
      - `open_rate` number, nullable, required: 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.
      - `click_rate` number, nullable, required: 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, required: Total 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_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh 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`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation.

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6dfce1179799?raw)