Stats by tag

GET

/v1/email/stats/tags

curl -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"

Returns aggregate delivery and engagement counts grouped by tag for the requested period. Rows are ranked by the sort metric (default processed) descending and capped at the requested limit (default 50, hard maximum 200). Use this to compare campaign performance across tags you set at send time. Rows are computed against event time (not send time), so engagement received during the period for messages sent earlier is included. The maximum window is 365 days; requesting a longer range returns 422.

Parametri di query

from

string

Start date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to 30 days before to when omitted; with include_trend=true and trend_grain=hourly the default tightens to 29 days before to, keeping the defaulted window within the 720-hour trend cap.

string

End 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.

timezone

string

IANA timezone identifier (for example Asia/Kathmandu or America/New_York) to report the statistics in. It is the single source of timezone: day and hour boundaries, and the relative window defaults used when from and to are omitted, are computed in this timezone instead of UTC, so a timezone with a sub-hour offset (such as India at +05:30 or Nepal at +05:45) still gets correct local-day and local-hour totals. When it is set, a from or to given as a calendar day names a local day in this timezone, and one given as an instant stays an absolute point in time but is rounded down to its hour and bucketed in this timezone (so the hour boundaries are local, not UTC). To avoid specifying the zone twice, a from or to that carries its own numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant instead. Defaults to UTC.

category

string

Email statistics are aggregated across all categories. Per-category filtering is not yet available; supplying this parameter returns 422.

sort

string

Metric to rank rows by, applied descending. Any count or rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. Defaults to processed.

limit

integer

Maximum number of tag rows to return, ranked by the sort field descending.

include_trend

boolean

When true, each row also carries a trend array: a short per-bucket series of that row's delivery and engagement rates over the window. Returned only when limit is 50 or fewer and the window is at most 90 days (trend_grain=daily) or 720 hours (trend_grain=hourly); a larger request returns 422. When from is omitted and trend_grain=hourly, the default window is 30 days (720 hours), so a request built entirely from defaults always fits the cap.

trend_grain

string

Bucket grain for the trend series. Has no effect unless include_trend=true.

Payload di risposta

period

object

obbligatorio

Mostra attributi secondari

period.from

string

obbligatorio

Inclusive start date the response covers (YYYY-MM-DD).

period.to

string

obbligatorio

Inclusive end date the response covers (YYYY-MM-DD).

period.data_as_of

nullable string

The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.

data

array of object

obbligatorio

Tag breakdown rows, ranked by the sort metric (default processed) descending. Empty when no tagged sends occurred in the period.

Mostra attributi secondari

data.tag

string

obbligatorio

The 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.delivery

object

obbligatorio

Mostra attributi secondari

data.delivery.accepted

integer

Distinct recipients accepted for delivery after suppression filtering. Reported on time buckets and the period summary; omitted on breakdown rows, whose rollups do not carry it.

data.delivery.processed

integer

obbligatorio

Distinct recipients whose message was processed and handed off for delivery.

data.delivery.delivered

integer

obbligatorio

Distinct recipients whose message the receiving mail server accepted.

data.delivery.bounced

integer

obbligatorio

Distinct recipients whose delivery failed. Approximately the sum of the five bounces.* sub-counts (hard, soft, admin, block, undetermined); the totals are computed independently so they may differ slightly at the approximation error.

data.delivery.bounces

object

obbligatorio

Mostra attributi secondari

data.delivery.bounces.hard

integer

obbligatorio

Distinct recipients with a permanent delivery failure (invalid address or non-existent domain).

data.delivery.bounces.soft

integer

obbligatorio

Distinct recipients with a transient delivery failure (mailbox full or server temporarily unavailable).

data.delivery.bounces.admin

integer

obbligatorio

Distinct recipients bounced by an upstream policy block (relaying denied, blocklisted domain).

data.delivery.bounces.block

integer

obbligatorio

Distinct recipients bounced because the receiving mail server blocked the sending IP for reputation reasons.

data.delivery.bounces.undetermined

integer

obbligatorio

Distinct recipients bounced where the receiving server's response did not allow precise classification.

data.delivery.bounces.hard_rate

nullable number

obbligatorio

Fraction of bounced recipients that hard bounced, computed as hard / bounced. Null when bounced is zero.

data.delivery.bounces.soft_rate

nullable number

obbligatorio

Fraction of bounced recipients that soft bounced, computed as soft / bounced. Null when bounced is zero.

data.delivery.bounces.admin_rate

nullable number

obbligatorio

Fraction of bounced recipients that admin bounced, computed as admin / bounced. Null when bounced is zero.

data.delivery.bounces.block_rate

nullable number

obbligatorio

Fraction of bounced recipients that block bounced, computed as block / bounced. Null when bounced is zero.

data.delivery.bounces.undetermined_rate

nullable number

obbligatorio

Fraction of bounced recipients with undetermined classification, computed as undetermined / bounced. Null when bounced is zero.

data.delivery.complained

integer

obbligatorio

Distinct recipients who reported the message as spam via a feedback loop.

data.delivery.deferred

integer

obbligatorio

Distinct recipients whose delivery the receiving server temporarily delayed and is still being retried.

data.delivery.rejected

integer

obbligatorio

Distinct 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_bounces

integer

obbligatorio

Out-of-band bounce events: distinct failure notifications received after the receiving server had initially confirmed delivery. Counted as deduplicated events, not unique recipients.

data.delivery.effective_delivered

integer

obbligatorio

Recipients who remain in-inbox in this scope 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_bounces

integer

obbligatorio

Total recipients in this scope who did not receive the message, computed as bounced + oob_bounces.

data.delivery.oob_rate

nullable number

obbligatorio

Share 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_rate

nullable number

obbligatorio

Share of this scope's delivery attempts that resulted in a message remaining in-inbox, computed as effective_delivered / (delivered + bounced). Null when there were no attempts.

data.delivery.bounce_rate

nullable number

obbligatorio

Share of this scope's delivery attempts that ultimately failed (inband or out-of-band), computed as all_bounces / (delivered + bounced). Null when there were no attempts.

data.delivery.complaint_rate

nullable number

obbligatorio

Spam 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.engagement

object

obbligatorio

Mostra attributi secondari

data.engagement.opens

integer

obbligatorio

Distinct open events, counting repeat opens from the same recipient and opens auto-fetched by inbox privacy features (such as Apple Mail Privacy Protection and the Gmail image proxy).

data.engagement.opens_non_prefetched

integer

obbligatorio

Distinct open events excluding those auto-fetched by inbox privacy features. Same event-counting semantics as opens (repeat opens from the same recipient count separately), with prefetched opens removed.

data.engagement.unique_opens

integer

obbligatorio

Distinct recipients who opened at least once, including opens auto-fetched by inbox privacy features.

data.engagement.unique_opens_non_prefetched

integer

obbligatorio

Distinct recipients who opened at least once, excluding opens auto-fetched by inbox privacy features. This is the numerator used for open rate, so iOS-heavy audiences (Apple Mail Privacy Protection and similar) do not inflate it.

data.engagement.clicks

integer

obbligatorio

Distinct click events, counting repeat clicks from the same recipient.

data.engagement.unique_clicks

integer

obbligatorio

Distinct recipients who clicked at least once.

data.engagement.unsubscribes

integer

obbligatorio

Distinct unsubscribe events, recorded via the list-unsubscribe header or the footer link.

data.engagement.open_rate

nullable number

obbligatorio

Distinct non-prefetched openers relative to recipients delivered in the same scope, computed as unique_opens_non_prefetched / delivery.delivered. The numerator excludes opens auto-fetched by inbox privacy features. Opens are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when delivery.delivered is zero.

data.engagement.click_rate

nullable number

obbligatorio

Distinct clickers relative to recipients delivered in the same scope, computed as unique_clicks / delivery.delivered. Clicks are attributed by event time, so engagement earned by earlier deliveries can push the rate above 1. Null when delivery.delivered is zero.

data.engagement.unsubscribe_rate

nullable number

obbligatorio

Unsubscribes relative to recipients delivered in the same scope, computed as unsubscribes / delivery.delivered. Unsubscribes are attributed by event time, so the rate can exceed 1. Null when delivery.delivered is zero.

data.latency

object

obbligatorio

Mostra attributi secondari

data.latency.processing

object

p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. Percentiles are approximate (computed from a high-volume aggregation pipeline). All three are null together when no qualifying event contributed a latency measurement in the bucket.

Mostra attributi secondari

data.latency.processing.p50_ms

nullable integer

obbligatorio

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.processing.p95_ms

nullable integer

obbligatorio

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.processing.p99_ms

nullable integer

obbligatorio

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.delivery

object

Mostra attributi secondari

data.latency.delivery.p50_ms

nullable integer

obbligatorio

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.delivery.p95_ms

nullable integer

obbligatorio

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.delivery.p99_ms

nullable integer

obbligatorio

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total

object

Mostra attributi secondari

data.latency.total.p50_ms

nullable integer

obbligatorio

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total.p95_ms

nullable integer

obbligatorio

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total.p99_ms

nullable integer

obbligatorio

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.trend

array of object

Per-bucket rate series for this tag over the window. Present only when include_trend=true.

Mostra attributi secondari

data.trend.bucket

string

obbligatorio

The day (YYYY-MM-DD) or hour (ISO 8601, on the hour) this point covers, matching the requested trend_grain.

data.trend.delivered

integer

obbligatorio

Delivered recipients in this bucket.

data.trend.bounced

integer

obbligatorio

Bounced recipients in this bucket.

data.trend.delivery_rate

nullable number

obbligatorio

Delivery rate for this bucket, as a fraction. Null when nothing was delivered or bounced.

data.trend.bounce_rate

nullable number

obbligatorio

Bounce rate for this bucket, as a fraction. Null when nothing was delivered or bounced.

data.trend.complaint_rate

nullable number

obbligatorio

Complaint rate for this bucket, as a fraction; event-time attribution can push it above 1 when complaints outrun the bucket's deliveries. Null when nothing was delivered in the bucket. On a sending-IP row complaints are not attributed to the IP, so this reads 0 in buckets that had deliveries and null in buckets that had none.

data.trend.open_rate

nullable number

obbligatorio

Open rate for this bucket, as a fraction; event-time attribution can push it above 1 when opens outrun the bucket's deliveries. Null when nothing was delivered in the bucket. On a sending-IP row engagement is not attributed to the IP, so this reads 0 in buckets that had deliveries and null in buckets that had none.

data.trend.click_rate

nullable number

obbligatorio

Click rate for this bucket, as a fraction; event-time attribution can push it above 1 when clicks outrun the bucket's deliveries. Null when nothing was delivered in the bucket. On a sending-IP row engagement is not attributed to the IP, so this reads 0 in buckets that had deliveries and null in buckets that had none.

total

integer

obbligatorio

Total number of distinct tags (name and value pairs) with activity in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped; raise limit (up to 200) or narrow the window to see more.

curl -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"