Get statistics by tag
/v1/email/stats/tagsconst { data } = await bird.email.stats.byTag({
from: "2026-05-01",
to: "2026-05-31",
sort: "delivered",
limit: 10,
});
for (const row of data) console.log(row.tag, row.delivery.delivered);stats = client.email.stats.by_tag(from_="2026-05-01", to="2026-05-25", sort="delivered")
for row in stats.data:
print(row)
print(stats.total)stats, err := client.Email.Stats.ByTag(context.Background(), bird.EmailStatsByTagParams{
Sort: "opens",
Limit: 10,
})
if err != nil {
log.Fatal(err)
}
fmt.Println(stats.Data)$stats = $bird->email->stats->byTag([
'from' => '2026-05-01',
'to' => '2026-05-31',
'sort' => 'delivered',
'limit' => 10,
]);
foreach ($stats->getData() ?? [] as $row) {
echo $row->getTag(), ' ', $row->getDelivery()?->getDelivered(), "\n";
}bird email stats by-tagcurl -X GET "https://us1.platform.bird.com/v1/email/stats/tags" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=processed" \
--url-query "limit=50" \
--url-query "include_trend=false" \
--url-query "trend_grain=daily"{
"period": {
"from": "2026-05-01",
"to": "2026-05-25",
"data_as_of": "2026-05-25T14:03:10Z"
},
"data": [
{
"tag": "campaign:welcome-series",
"delivery": {
"accepted": 14820,
"processed": 14810,
"delivered": 14720,
"bounced": 90,
"bounces": {
"hard": 12410,
"soft": 14290,
"admin": 410,
"block": 920,
"undetermined": 80,
"hard_rate": 0.454,
"soft_rate": 0.523,
"admin_rate": 0.015,
"block_rate": 0.0337,
"undetermined_rate": 0.0029
},
"complained": 3,
"deferred": 14,
"rejected": 10,
"oob_bounces": 2,
"effective_delivered": 14718,
"all_bounces": 92,
"oob_rate": 0.00014,
"delivery_rate": 0.9939,
"bounce_rate": 0.0061,
"complaint_rate": 0.0002
},
"engagement": {
"opens": 5420,
"opens_non_prefetched": 3210,
"unique_opens": 3640,
"unique_opens_non_prefetched": 2480,
"clicks": 924,
"unique_clicks": 621,
"unsubscribes": 12,
"open_rate": 0.1683,
"click_rate": 0.0422,
"unsubscribe_rate": 0.0009
},
"latency": {
"processing": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
},
"delivery": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
},
"total": {
"p50_ms": 420,
"p95_ms": 1820,
"p99_ms": 4920
}
},
"trend": [
{
"bucket": "2026-05-12"
}
]
}
],
"total": 173,
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns delivery and engagement counts for the requested period, grouped by tag. Use it to compare performance across the tags you set at send time. Rows are ranked by the sort metric, processed by default, and paginated with the requested limit (50 by default, 200 at most).
Rows are computed against event time rather than send time, so engagement received during the period counts even for messages that were sent earlier.
The window can span at most 365 days. Ask for more and you get a 422.
Parámetros de consulta
namestringRestrict the breakdown to this tag name. Names match case-sensitively.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
fromstringStart date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). It defaults to 30 days before to when you leave it out. When include_trend=true and trend_grain=hourly, that default tightens to 29 days before to instead, so the defaulted window still fits inside the 720-hour trend cap.
tostringEnd date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.
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.
categorystringNot supported on breakdown endpoints. Supplying it returns 422. To compare categories, use GET /v1/email/stats/categories. The summary, daily, and hourly statistics accept category as a filter.
sortstringMetric to rank rows by, applied descending. Any count or rate in the response can be used. A row whose rate is undefined because its denominator is zero sorts last. It defaults to processed.
Possible values: processed, delivered, bounced, complained, deferred, rejected, oob_bounces, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined, opens, opens_non_prefetched, unique_opens, unique_opens_non_prefetched, clicks, unique_clicks, unsubscribes, delivery_rate, bounce_rate, complaint_rate, open_rate, click_rate, unsubscribe_rate, bounces.hard_rate, bounces.soft_rate, bounces.admin_rate, bounces.block_rate, bounces.undetermined_rate
limitintegerMaximum number of tag rows to return, ranked by the sort field descending.
include_trendbooleanWhen true, each row also gets a trend array: a short per-bucket series showing that tag's delivery and engagement rates over the window. This only works when limit is 50 or fewer and the window is at most 90 days for trend_grain=daily or 720 hours for trend_grain=hourly. Ask for more and you get a 422. When you leave from out and use trend_grain=hourly, the default window tightens to 29 days before to (720 hours total), so a request built entirely from defaults always fits inside the cap.
trend_grainstringBucket grain for the trend series. Has no effect unless include_trend=true.
Possible values: daily, hourly
Carga de respuesta
periodThe date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
dataTag breakdown rows, ranked by the sort metric (default processed) descending. Empty when no tagged sends occurred in the period.
Mostrar atributos secundarios
data.tagThe tag this row aggregates, formatted as name:value from the tag set at send time (for example campaign:welcome-series). Each distinct name-and-value pair is its own row.
data.deliveryMostrar atributos secundarios
data.delivery.acceptedDistinct recipients accepted for delivery after suppression filtering. Reported on time buckets and the period summary. Breakdown rows leave it out, because their rollups do not have it.
data.delivery.processedDistinct recipients whose message was processed and handed off for delivery.
data.delivery.deliveredDistinct recipients whose message the receiving mail server accepted.
data.delivery.bouncedDistinct recipients whose delivery failed. This is approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined). The two totals are worked out independently, so they can differ slightly.
data.delivery.bouncesdata.delivery.complainedDistinct recipients who reported the message as spam via a feedback loop.
data.delivery.deferredDistinct recipients whose delivery the receiving server temporarily delayed and is still being retried.
data.delivery.rejectedDistinct recipients rejected before any delivery attempt. Includes recipients on the workspace suppression list, transmissions that could not be completed, message-generation failures, and recipients refused by sending policy. The per-recipient rejection_reason field on GET /v1/email/messages/{message_id}/recipients surfaces the specific cause.
data.delivery.oob_bouncesOut-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. The count represents deduplicated events rather than unique recipients.
data.delivery.effective_deliveredRecipients who remain delivered after all bounce signals resolve, computed as delivered - oob_bounces. Use this as the base for engagement-rate denominators. Clamped to 0 when oob_bounces exceeds delivered.
data.delivery.all_bouncesTotal recipients in this scope who did not receive the message, computed as bounced + oob_bounces.
data.delivery.oob_rateShare of this scope's delivery attempts that resulted in an out-of-band bounce, computed as oob_bounces / (delivered + bounced). Null when there were no attempts.
data.delivery.delivery_rateShare of this scope's delivery attempts that remained delivered after all bounce signals, computed as effective_delivered / (delivered + bounced). Null when there were no attempts.
data.delivery.bounce_rateShare of this scope's delivery attempts that ultimately failed (inband or out-of-band), computed as all_bounces / (delivered + bounced). Because oob_bounces counts events rather than recipients, all_bounces can exceed the attempt count. The rate is clamped to 1. Null when there were no attempts.
data.delivery.complaint_rateSpam complaints in this scope relative to effectively delivered recipients, computed as complained / effective_delivered. Complaints are attributed by event time, so a scope can record more of them than it effectively delivered, pushing the rate above 1. Null when effective_delivered is zero.
data.engagementdata.latencydata.trendPer-bucket rate series for this tag over the window. Present only when include_trend=true.
totalTotal number of distinct tags (name and value pairs) with activity in the period, regardless of limit. Pass next_cursor as starting_after to request the next page.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Recursos relacionados
Continúa con la documentación, guías y ejemplos de este tema.