Get outbound WhatsApp statistics by template category
/v1/whatsapp/stats/template-categoriesconst stats = await bird.whatsapp.stats.byTemplateCategory({ from: "2026-08-01", to: "2026-08-31" });
for (const row of stats.data ?? []) {
console.log(row.category, row.delivery);
}stats = client.whatsapp.stats.by_template_category(from_="2026-08-01", to="2026-08-31")
for row in stats.data or []:
print(row.category, row.delivery)stats, err := client.Whatsapp.Stats.ByTemplateCategory(context.Background(), bird.WhatsappStatsByTemplateCategoryParams{
From: time.Now().AddDate(0, -1, 0),
To: time.Now(),
})
if err != nil {
log.Fatal(err)
}
for _, row := range *stats.Data {
fmt.Println(*row.Category, *row.Delivery.Accepted)
}$byTemplateCategory = $bird->whatsapp->stats->byTemplateCategory(['from' => '2026-08-01', 'to' => '2026-08-31']);
foreach ($byTemplateCategory->getData() ?? [] as $row) {
echo $row->getCategory(), ' ', $row->getDelivery()?->getAccepted(), PHP_EOL;
}bird whatsapp stats by-template-categorycurl -X GET "https://us1.platform.bird.com/v1/whatsapp/stats/template-categories" \
-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": [
{
"category": "authentication",
"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 lifecycle counts and delivery rates for WhatsApp messages grouped by template category for the requested period. 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. 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.
查询参数
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-category rows to return, ranked by accepted volume descending.
响应载荷
periodThe window the response covers (echoed back), plus data_as_of.
显示子属性
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.
dataCategory rows ranked by accepted volume descending.
显示子属性
data.categoryThe template category this row aggregates.
data.delivery显示子属性
data.delivery.acceptedDistinct messages accepted for sending after admission checks. This is the denominator for delivery_rate and failure_rate.
data.delivery.sentDistinct messages handed off for delivery.
data.delivery.deliveredDistinct messages confirmed delivered to the recipient's device.
data.delivery.failedDistinct messages that failed during sending or delivery.
data.delivery.rejectedDistinct messages rejected before any send attempt, because the recipient is on the workspace's suppression list, no reachable recipient was given, the destination has no price, or the wallet could not fund the send. Rejected messages are never charged and are not counted in accepted, so the total addressed is accepted + rejected. Excluded from failure_rate, which covers send failures only.
data.delivery.delivery_rateShare of accepted messages that were delivered, computed as delivered / accepted. Null when no messages were accepted in scope.
data.delivery.failure_rateShare of accepted messages that ultimately failed, computed as failed / accepted. Null when no messages were accepted in scope.
data.engagement显示子属性
data.engagement.readDistinct messages confirmed read by the recipient.
data.engagement.read_rateDistinct messages read relative to messages delivered in the same scope, computed as read / delivery.delivered. Both counts are attributed by send time, so a read is counted alongside its own message's delivery. The rate can exceed 1 where a read receipt arrived for a message whose delivery receipt did not, or, at high volume, because the counts are close estimates. Null when delivery.delivered is zero.
data.latency显示子属性
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.processing.p50_msMedian (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.processing.p95_ms95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.processing.p99_ms99th percentile latency in milliseconds. 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.delivery.p50_msMedian (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p95_ms95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.
data.latency.delivery.p99_ms99th percentile latency in milliseconds. 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.
显示子属性
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 categories with activity in the period, regardless of limit.