Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Get aggregate outbound SMS statistics

GET
/v1/sms/stats/summary
const summary = await bird.sms.stats.summary({
  from: "2026-05-01", // both calendar days for a day window, or
  to: "2026-05-31", //   both RFC 3339 instants for an hour window
});
console.log(summary.delivery, summary.latency);
Réponse200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "delivery": {
    "accepted": 14820,
    "sent": 14810,
    "delivered": 14720,
    "undelivered": 60,
    "failed": 25,
    "rejected": 10,
    "expired": 5,
    "delivery_rate": 0.9932,
    "failure_rate": 0.0061
  },
  "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"
    },
    "delivery": {
      "accepted": 14820,
      "sent": 14810,
      "delivered": 14720,
      "undelivered": 60,
      "failed": 25,
      "rejected": 10,
      "expired": 5,
      "delivery_rate": 0.9932,
      "failure_rate": 0.0061
    },
    "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": {
      "accepted_pct_change": 0.508,
      "sent_pct_change": 0.121,
      "delivered_pct_change": 0.122,
      "undelivered_pct_change": -0.031,
      "failed_pct_change": -0.018,
      "rejected_pct_change": 0,
      "expired_pct_change": 0.04,
      "delivery_rate_pp": 0.004,
      "failure_rate_pp": -0.0008
    }
  }
}

Returns one aggregate row for the requested period. It includes SMS lifecycle counts, delivery and failure rates, and processing, delivery, and total latency percentiles (p50, p95, and p99). Rows use send-time attribution, so recent periods can under-report delivered while delivery reports arrive.

Rate fields are null when their denominator is zero. For example, delivery_rate is null when no message was accepted.

from and to must both be days or RFC 3339 instants. Day windows cover up to 365 days. Instant bounds round down to the hour and may span up to 720 hours. Mixing the forms returns 422. Set timezone for local boundaries, one dimension filter at most, or compare=previous_period for the preceding equal-length window.

Paramètres de requête

fromstring

Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as to. When omitted, it defaults to 30 days before to for day windows or 168 hours (7 days) before to for hour windows.

tostring

Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as from. When omitted, it defaults to today for day windows or the current hour for hour windows in that timezone. 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.

originatorstring

Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (country, category, carrier); only one may be set per request. Matches the message from.

countrystring

Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (originator, category, carrier); only one may be set per request.

categorystring

Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (originator, country, carrier); only one may be set per request.

carrierstring

Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (originator, country, category); only one may be set per request.

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

Contenu de la réponse

period
object
obligatoire

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.

Afficher les attributs enfants
delivery
object
obligatoire
Afficher les attributs enfants
latency
object
obligatoire
Afficher les attributs enfants
comparison
object
Afficher les attributs enfants

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Essayez la pratique et obtenez un guide d'implémentation