Get outbound WhatsApp statistics by tag
/v1/whatsapp/stats/tagsconst stats = await bird.whatsapp.stats.byTag({ from: "2026-08-01", to: "2026-08-31" });
for (const row of stats.data ?? []) {
console.log(row.tag, row.delivery);
}stats = client.whatsapp.stats.by_tag(from_="2026-08-01", to="2026-08-31")
for row in stats.data or []:
print(row.tag, row.delivery)stats, err := client.Whatsapp.Stats.ByTag(context.Background(), bird.WhatsappStatsByTagParams{
From: time.Now().AddDate(0, -1, 0),
To: time.Now(),
})
if err != nil {
log.Fatal(err)
}
for _, row := range *stats.Data {
fmt.Println(*row.Tag, *row.Delivery.Accepted)
}$byTag = $bird->whatsapp->stats->byTag(['from' => '2026-08-01', 'to' => '2026-08-31']);
foreach ($byTag->getData() ?? [] as $row) {
echo $row->getTag(), ' ', $row->getDelivery()?->getAccepted(), PHP_EOL;
}bird whatsapp stats by-tagcurl -X GET "https://us1.platform.bird.com/v1/whatsapp/stats/tags" \
-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": [
{
"tag": "campaign:summer_sale",
"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": 12
}
Returns lifecycle counts and delivery rates for WhatsApp messages grouped by tag (name:value) 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.
Abfrageparameter
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 tag rows to return, ranked by accepted volume descending.
Antwort-Payload
periodThe window the response covers (echoed back), plus data_as_of.
dataTag rows ranked by accepted volume descending.
Untergeordnete Attribute anzeigen
data.tagThe tag this row aggregates, in name:value form.
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.
Untergeordnete Attribute anzeigen
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.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.
totalTotal distinct tags with activity in the period, regardless of limit.
Verwandte Ressourcen
Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.