Sign inGet Started

Get outbound WhatsApp statistics by country

GET
/v1/whatsapp/stats/countries
const stats = await bird.whatsapp.stats.byCountry({ from: "2026-08-01", to: "2026-08-31" });
for (const row of stats.data ?? []) {
  console.log(row.country, row.delivery);
}
Réponse200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "country": "US",
      "delivery": {
        "accepted": 4820,
        "sent": 4810,
        "delivered": 4720,
        "failed": 25,
        "rejected": 412,
        "delivery_rate": 0.9793,
        "failure_rate": 0.0052
      },
      "engagement": {
        "read": 3105,
        "read_rate": 0.6578
      },
      "latency": {
        "processing": {
          "p50_ms": 610,
          "p95_ms": 2140,
          "p99_ms": 5380
        },
        "delivery": {
          "p50_ms": 1530,
          "p95_ms": 6820,
          "p99_ms": 18400
        },
        "total": {
          "p50_ms": 2180,
          "p95_ms": 9060,
          "p99_ms": 24300
        }
      }
    }
  ],
  "total": 4
}

Returns delivery counts, read engagement and latency grouped by the recipient's destination country. Rows use send-time attribution, rank by accepted volume, and are capped by limit (default 50, maximum 200). A recent period under-reports delivered while delivery reports are still arriving. The maximum window is 365 days; a longer range returns 422.

A country row covers messages addressed to a single recipient. A recipient whose country cannot be resolved (a number shaped like a phone number that belongs to no country, or a non-geographic range such as freephone) is counted under ZZ rather than dropped, matching the SMS country breakdown. Group sends are omitted entirely: one spans up to eight recipients in as many countries, so no single destination country describes it. These rows therefore sum to the summary less that group volume. A window reaching before this breakdown shipped falls short by more than that: history was seeded only where the recipient's country could be recovered from stored data, so a phone-addressed send accepted before the cutover has no accepted leg here. Two cases follow, and they read differently. Acceptance days more than 14 days before the cutover are a plain shortfall and never change. In the 14 days immediately before it, a delivered, read or failed callback arriving after the cutover does carry a country and is attributed to its original acceptance day, so a row there can report deliveries with accepted at zero. Its delivery_rate and failure_rate are then null for want of a denominator while read_rate still computes and looks healthy. The 14 days are the status recording window, after which a callback is dropped. All of this is confined to pre-cutover acceptance days and gone once the requested window starts after the cutover date.

Latency reports the same three families as the summary: processing, delivery and total. The delivery family depends on a best-effort handoff timestamp that a fast delivery callback can beat, so it can be absent for a country whose other two families are present.

A breakdown is already a single-dimension view and takes no dimension filter; to restrict statistics to a single template, category, phone number or tag, use the summary, daily or hourly statistics instead.

Paramètres de requête

fromstring

Inclusive start of the window, a calendar day (YYYY-MM-DD). Interpreted in timezone, or UTC when omitted. Must not be after to. Max window 365 days. Defaults to 30 days before to when omitted.

tostring

Inclusive end of the window, a calendar day (YYYY-MM-DD). Interpreted in timezone, or UTC when omitted. Max window 365 days. Defaults to today in that timezone when omitted.

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.

limitinteger

Maximum number of country rows to return, ranked by accepted volume descending.

Contenu de la réponse

period
object
obligatoire

The window the response covers (echoed back), plus data_as_of.

Afficher les attributs enfants
data
array of object
obligatoire

Country rows ranked by accepted volume descending. Empty when no eligible activity occurred in the period; rows sum to the summary less group-send volume, and less any pre-cutover phone-addressed sends still inside the window.

Afficher les attributs enfants
data.country
string
obligatoire

The destination country this row aggregates, as an ISO 3166-1 alpha-2 code. ZZ collects recipients whose country could not be resolved.

data.delivery
object
obligatoire
Afficher les attributs enfants
data.engagement
object
obligatoire
Afficher les attributs enfants
data.latency
object
obligatoire
Afficher les attributs enfants
total
integer
obligatoire

Total distinct countries with activity in the period, regardless of limit.

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