Sign inGet Started
Mulai sekarang
Panduan
Referensi API
SDK
CLI
Basis Pengetahuan
Changelog

Get outbound WhatsApp statistics by phone number

GET
/v1/whatsapp/stats/phone-numbers
const stats = await bird.whatsapp.stats.byPhoneNumber({ from: "2026-08-01", to: "2026-08-31" });
for (const row of stats.data ?? []) {
  console.log(row.phone_number, row.delivery);
}
Respons200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "phone_number": "+13124495569",
      "shared": true,
      "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": 2
}

Returns delivery counts grouped by business phone number, including whether each is platform-managed or customer-owned. 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 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. Each row also carries the same three latency families as the summary: processing, delivery and total. delivery is measured from a best-effort handoff timestamp that a fast delivery callback can beat, so it can be absent for a row whose other two families are present.

Parameter Kueri

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 phone-number rows to return, ranked by accepted volume descending.

Payload Respons

period
object
wajib

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

Tampilkan atribut turunan
data
array of object
wajib

Phone-number rows ranked by accepted volume descending.

Tampilkan atribut turunan
data.phone_number
string
wajib

The business sender phone number in E.164 form.

data.shared
boolean
wajib

true for a shared Bird-managed number; false for a number owned by your workspace.

data.delivery
object
wajib

WhatsApp lifecycle counts and rates for the requested period, attributed by send time, so a later delivery stays attributed to the period in which its message was accepted, and a recent period under-reports delivered while delivery reports are still arriving. The sibling engagement block reports read counts and rates. Rates are null when their denominator is zero. Very large counts are close estimates rather than exact tallies.

Tampilkan atribut turunan
data.engagement
object
wajib

WhatsApp engagement counts and the derived read rate for the scope of the containing row (the whole requested period or a breakdown dimension). The read field is the number of distinct messages confirmed read by the recipient. Send time determines attribution; the instant the read receipt arrived does not. A read is counted in the period its message was accepted in, alongside that message's own delivery when one arrived. The read rate divides reads by messages delivered in the same scope and is null when its denominator is zero. Very large counts are close estimates rather than exact tallies.

Tampilkan atribut turunan
data.latency
object
wajib

Latency percentiles in milliseconds for the requested scope:

  • processing: From acceptance to WhatsApp handoff.
  • delivery: From WhatsApp handoff to delivery confirmation.
  • total: From acceptance to delivery confirmation.

Each family is omitted when no qualifying message contributes a measurement. Individual percentiles can also be null. delivery is measured on a best-effort basis, so it can be absent for a scope whose processing and total are present.

Tampilkan atribut turunan
total
integer
wajib

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

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Dapatkan ringkasan implementasi