Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

Get aggregate email statistics

GET
/v1/email/stats/summary
const s = await bird.email.stats.summary({ from: "2026-05-01", to: "2026-05-31" });
console.log(s.sends_accepted, s.delivery.delivered);
Odpowiedź200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "sends_accepted": 12410,
  "delivery": {
    "accepted": 14820,
    "processed": 14810,
    "delivered": 14720,
    "bounced": 90,
    "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
    },
    "complained": 3,
    "deferred": 14,
    "rejected": 10,
    "oob_bounces": 2,
    "effective_delivered": 14718,
    "all_bounces": 92,
    "oob_rate": 0.00014,
    "delivery_rate": 0.9939,
    "bounce_rate": 0.0061,
    "complaint_rate": 0.0002
  },
  "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": {
    "processing": {
      "p50_ms": 420,
      "p95_ms": 1820,
      "p99_ms": 4920
    },
    "delivery": {
      "p50_ms": 420,
      "p95_ms": 1820,
      "p99_ms": 4920
    },
    "total": {
      "p50_ms": 420,
      "p95_ms": 1820,
      "p99_ms": 4920
    }
  },
  "comparison": {
    "period": {
      "from": "2026-05-01",
      "to": "2026-05-25",
      "data_as_of": "2026-05-25T14:03:10Z"
    },
    "sends_accepted": 8230,
    "delivery": {
      "accepted": 14820,
      "processed": 14810,
      "delivered": 14720,
      "bounced": 90,
      "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
      },
      "complained": 3,
      "deferred": 14,
      "rejected": 10,
      "oob_bounces": 2,
      "effective_delivered": 14718,
      "all_bounces": 92,
      "oob_rate": 0.00014,
      "delivery_rate": 0.9939,
      "bounce_rate": 0.0061,
      "complaint_rate": 0.0002
    },
    "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": {
      "processing": {
        "p50_ms": 420,
        "p95_ms": 1820,
        "p99_ms": 4920
      },
      "delivery": {
        "p50_ms": 420,
        "p95_ms": 1820,
        "p99_ms": 4920
      },
      "total": {
        "p50_ms": 420,
        "p95_ms": 1820,
        "p99_ms": 4920
      }
    },
    "delta": {
      "sends_accepted_pct_change": 0.508,
      "delivered_pct_change": 0.122,
      "bounced_pct_change": -0.031,
      "complained_pct_change": 0.018,
      "opened_pct_change": -0.046,
      "delivery_rate_pp": 0.004,
      "open_rate_pp": 0.005,
      "click_rate_pp": 0.002,
      "bounce_rate_pp": -0.0008,
      "complaint_rate_pp": 0.0001,
      "unsubscribe_rate_pp": -0.0001
    }
  }
}

Returns a single-row aggregate across the requested period covering delivery, bounce, complaint, open, and click counts plus the derived rates, along with processing, delivery, and total latency percentiles (p50/p95/p99). Suitable for KPI tiles, campaign reports, and email digests; the daily and hourly endpoints have the same metrics per time bucket.

The aggregate is computed against event time (not send time), so engagement received during the period for messages sent earlier is included. Rate fields are null when their denominator is zero.

The window grain follows the form of from and to: calendar days (YYYY-MM-DD, up to 365 days) or RFC 3339 instants (hour grain, up to 720 hours, 30 days). A rolling window such as the last 24 hours is a single request. Mixing the two forms returns 422. Set timezone to compute day and hour boundaries in a local zone instead of UTC, and compare=previous_period to include the preceding equal-length window in the same response.

Parametry zapytania

fromstring

Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day; an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as to. Defaults to 30 days before to for day windows, or 168 hours (7 days) before to for hour windows, when omitted.

tostring

Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day; an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as from. Defaults to today for day windows, or the current hour for hour windows, in that timezone, when omitted. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days).

timezonestring

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.

categorystring

Restrict the statistics to a category or a comma-separated union of categories: transactional or marketing. Mutually exclusive with the other dimension filters; only one may be set per request.

sending_domainstring

Restrict the statistics to a sending domain or a comma-separated union of sending domains (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.

tagstring

Restrict the statistics to a tag. Use name to match any value of a tag, or name:value for a specific pair (for example campaign:spring_launch). To combine values of one tag name, separate complete pairs with commas, such as campaign:spring,campaign:summer. Different tag names cannot be combined. Mutually exclusive with the other dimension filters; only one may be set per request.

sending_ipstring

Restrict the statistics to a sending IP or a comma-separated union of IPs. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is assigned only after a message reaches delivery, so this filter reports delivery-side metrics only. Accepted, processed, rejected, complaint, and engagement counts are 0, and processing latency is null. Complaint, open, and click rates are 0 when deliveries exist and null otherwise.

recipient_domainstring

Restrict the statistics to a recipient mailbox domain or a comma-separated union of domains (the part of the recipient address after the @, for example gmail.com). Mutually exclusive with the other dimension filters; only one may be set per request.

templatestring

Restricts the statistics to a template or a comma-separated union of templates, identified by ID (emt_…) or name. This parameter is mutually exclusive with other dimension filters.

comparestring

Set to previous_period to also include the same statistics for the immediately preceding window of equal length, plus the change between the two, so you can show "+X% vs last period" without a second request.

Possible values: previous_period

Treść odpowiedzi

period
object
wymagane

The window the response covers (echoed back from the request, day or hour grain), plus data_as_of, the freshness boundary the data is current to.

Pokaż atrybuty podrzędne
sends_accepted
integer
wymagane

Distinct email messages accepted, counted at the message level (one per accepted send regardless of recipient count) across the whole requested period. This field counts messages. delivery.accepted counts recipients, so the two values are not comparable (a single message to 500 recipients is 1 here and up to 500 there).

delivery
object
wymagane
Pokaż atrybuty podrzędne
engagement
object
wymagane
Pokaż atrybuty podrzędne
latency
object
wymagane
Pokaż atrybuty podrzędne
comparison
object
Pokaż atrybuty podrzędne
comparison.period
object
wymagane

The preceding window these comparison figures cover, the equal-length window ending immediately before the requested start (the prior day for day windows, the prior hour for hour windows). For a request covering 2026-05-01 to 2026-05-31, this is 2026-03-31 to 2026-04-30, both inclusive.

Pokaż atrybuty podrzędne
comparison.sends_accepted
integer
wymagane

Distinct email messages accepted in the preceding period, counted at the message level.

comparison.delivery
object
wymagane
Pokaż atrybuty podrzędne
comparison.engagement
object
wymagane
Pokaż atrybuty podrzędne
comparison.latency
object
wymagane
Pokaż atrybuty podrzędne
comparison.delta
object
wymagane
Pokaż atrybuty podrzędne
comparison.delta.sends_accepted_pct_change
nullable number
wymagane

Relative change in accepted messages (the sends_accepted count) versus the previous period, as a signed fraction. Null when the previous period accepted none.

comparison.delta.delivered_pct_change
nullable number
wymagane

Relative change in effectively delivered recipients (delivery.effective_delivered, the delivery-rate numerator) versus the previous period, as a signed fraction. Null when the previous period effectively delivered none.

comparison.delta.bounced_pct_change
nullable number
wymagane

Relative change in total bounces including out-of-band (delivery.all_bounces, the bounce-rate numerator) versus the previous period, as a signed fraction. Null when the previous period had none.

comparison.delta.complained_pct_change
nullable number
wymagane

Relative change in spam complaints (delivery.complained) versus the previous period, as a signed fraction. Null when the previous period had none.

comparison.delta.opened_pct_change
nullable number
wymagane

Relative change in unique non-prefetched opens (engagement.unique_opens_non_prefetched, the same count the open rate uses) versus the previous period, as a signed fraction. Null when the previous period had none.

comparison.delta.delivery_rate_pp
nullable number
wymagane

Signed difference between this period's and the previous period's delivery rate, both fractions in [0,1] (multiply by 100 for percentage points). Null when either period's delivery rate is undefined.

comparison.delta.open_rate_pp
nullable number
wymagane

Signed difference between this period's and the previous period's open rate, both fractions (multiply by 100 for percentage points). Null when either period's open rate is undefined.

comparison.delta.click_rate_pp
nullable number
wymagane

Signed difference between this period's and the previous period's click rate, both fractions (multiply by 100 for percentage points). Null when either period's click rate is undefined.

comparison.delta.bounce_rate_pp
nullable number
wymagane

Signed difference between this period's and the previous period's bounce rate, both fractions in [0,1] (multiply by 100 for percentage points). Null when either period's bounce rate is undefined.

comparison.delta.complaint_rate_pp
nullable number
wymagane

Signed difference between this period's and the previous period's complaint rate, both fractions (multiply by 100 for percentage points). Null when either period's complaint rate is undefined.

comparison.delta.unsubscribe_rate_pp
nullable number
wymagane

Signed difference between this period's and the previous period's unsubscribe rate, both fractions (multiply by 100 for percentage points). Null when either period's unsubscribe rate is undefined.

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy