Get outbound WhatsApp statistics by phone number
/v1/whatsapp/stats/phone-numbersconst 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);
}stats = client.whatsapp.stats.by_phone_number(from_="2026-08-01", to="2026-08-31")
for row in stats.data or []:
print(row.phone_number, row.delivery)stats, err := client.Whatsapp.Stats.ByPhoneNumber(context.Background(), bird.WhatsappStatsByPhoneNumberParams{
From: time.Now().AddDate(0, -1, 0),
To: time.Now(),
})
if err != nil {
log.Fatal(err)
}
for _, row := range *stats.Data {
fmt.Println(*row.PhoneNumber, *row.Delivery.Accepted)
}$byPhoneNumber = $bird->whatsapp->stats->byPhoneNumber(['from' => '2026-08-01', 'to' => '2026-08-31']);
foreach ($byPhoneNumber->getData() ?? [] as $row) {
echo $row->getPhoneNumber(), ' ', $row->getDelivery()?->getAccepted(), PHP_EOL;
}bird whatsapp stats by-phone-numbercurl -X GET "https://us1.platform.bird.com/v1/whatsapp/stats/phone-numbers" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=50"{
"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.
Query Parameters
fromstringInclusive 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.
tostringInclusive 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.
timezonestringIANA 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.
limitintegerMaximum number of phone-number rows to return, ranked by accepted volume descending.
Response Payload
periodThe window the response covers (echoed back), plus data_as_of.
Show child attributes
period.fromInclusive start of the window, as a calendar day (YYYY-MM-DD) or an RFC 3339 hour boundary.
period.toInclusive end of the window, as a calendar day (YYYY-MM-DD) or an RFC 3339 hour boundary.
period.data_as_ofLatest time reflected in the statistics. More recent events might not be included yet. Null when the freshness boundary is unavailable.
dataPhone-number rows ranked by accepted volume descending.
totalTotal distinct phone numbers with activity in the period, regardless of limit.
Related resources
Continue with the documentation, guides and examples for this topic.