Get outbound WhatsApp statistics by template
/v1/whatsapp/stats/templatesconst stats = await bird.whatsapp.stats.byTemplate({ from: "2026-08-01", to: "2026-08-31" });
for (const row of stats.data ?? []) {
console.log(row.template_id, row.delivery);
}stats = client.whatsapp.stats.by_template(from_="2026-08-01", to="2026-08-31")
for row in stats.data or []:
print(row.template_id, row.delivery)stats, err := client.Whatsapp.Stats.ByTemplate(context.Background(), bird.WhatsappStatsByTemplateParams{
From: time.Now().AddDate(0, -1, 0),
To: time.Now(),
})
if err != nil {
log.Fatal(err)
}
for _, row := range *stats.Data {
fmt.Println(*row.TemplateId, *row.Delivery.Accepted)
}$byTemplate = $bird->whatsapp->stats->byTemplate(['from' => '2026-08-01', 'to' => '2026-08-31']);
foreach ($byTemplate->getData() ?? [] as $row) {
echo $row->getTemplateId(), ' ', $row->getDelivery()?->getAccepted(), PHP_EOL;
}bird whatsapp stats by-templatecurl -X GET "https://us1.platform.bird.com/v1/whatsapp/stats/templates" \
-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": [
{
"template_id": "wat_01krdgeqcxet5s7t44vh8rt9mg",
"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": 7
}
Returns lifecycle counts and delivery rates for WhatsApp messages grouped by the template they were sent from, for the requested period. Rows are keyed by template_id, matching the email template breakdown, so a renamed template stays one row. Rows are ranked by accepted volume descending and capped at the requested limit (default 50, max 200). Rows use send-time attribution. A delivery confirmed during the period for a message accepted earlier counts against the earlier period. A recent period therefore under-reports delivered while delivery reports are still arriving, and its counts grow as reports arrive. 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. For the coarser split across Meta's marketing, utility, and authentication categories, use the template-categories breakdown 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 template rows to return, ranked by accepted volume descending.
Response Payload
periodThe window the response covers (echoed back), plus data_as_of.
dataTemplate rows ranked by accepted volume descending.
Show child attributes
data.template_idThe template these messages were sent from, using the same id the WhatsApp template endpoints return. A send that resolved no template does not appear in this breakdown. A template renamed after it was used to send still reports under this one id, and a template deleted after sending keeps its row rather than dropping the messages.
data.deliveryWhatsApp 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.
data.engagementWhatsApp 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.
data.latencyLatency 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.
Show child attributes
data.latency.processingApproximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
data.latency.deliveryApproximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
data.latency.totalApproximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
Show child attributes
data.latency.total.p50_msMedian (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p95_ms95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.total.p99_ms99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
totalTotal distinct templates with activity in the period, regardless of limit.
Related resources
Continue with the documentation, guides and examples for this topic.