<Intro>

<EndpointHeader />

<Description>

Returns one row of aggregate sending statistics per calendar day (UTC) for the workspace.
Rows are bucketed by event time, not send time — a complaint received on Wednesday for a message sent the prior Monday is counted in Wednesday's row. Days with no activity are still included with zero counts.
The response is well suited for charts and trend lines; for per-message exact accounting use the message detail endpoints.
The maximum window is 365 days; requesting a longer range returns 422.
Set `timezone` to report rows by your local calendar day instead of UTC; the full 365-day window is available in any timezone.

</Description>

</Intro>

<Parameters in="query">

<Parameter name="from" type="string">

<Description>

Start date (inclusive), 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.

</Description>

</Parameter>

<Parameter name="to" type="string">

<Description>

End date (inclusive), 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.

</Description>

</Parameter>

<Parameter name="timezone" type="string">

<Description>

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.

</Description>

</Parameter>

<Parameter name="category" type="string">

<Description>

Restrict the statistics to a single category: `transactional` or `marketing`. Mutually exclusive with the other dimension filters; only one may be set per request.

</Description>

</Parameter>

<Parameter name="sending_domain" type="string">

<Description>

Restrict the statistics to a single sending domain (the part of the From address after @). Mutually exclusive with the other dimension filters; only one may be set per request.

</Description>

</Parameter>

<Parameter name="tag" type="string">

<Description>

Restrict the statistics to a single tag. Use `name` to match any value of a tag, or `name:value` for a specific pair (for example `campaign:spring_launch`). Mutually exclusive with the other dimension filters; only one may be set per request.

</Description>

</Parameter>

<Parameter name="sending_ip" type="string">

<Description>

Restrict the statistics to a single sending IP. Mutually exclusive with the other dimension filters; only one may be set per request. A sending IP is only assigned once a message reaches delivery, so an IP-filtered result reports delivery-side metrics only: accepted, processed, rejected, complaint, and engagement counts are 0 and the processing latency is null; complaint, open, and click rates read 0 when there were deliveries and null when there were none.

</Description>

</Parameter>

<Parameter name="recipient_domain" type="string">

<Description>

Restrict the statistics to a single recipient mailbox domain (the part of the recipient address after the `@`, for example `gmail.com`). Mutually exclusive with the other dimension filters; only one may be set per request.

</Description>

</Parameter>

<Parameter name="template" type="string">

<Description>

Restrict the statistics to a single template, by its ID (`emt_…`) or its name. Mutually exclusive with the other dimension filters; only one may be set per request.

</Description>

</Parameter>

</Parameters>

<Payload kind="response">

<Field name="period" type="object" required>

<Description>

The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.

</Description>

<FieldChildren kind="response">

<Field name="from" type="string" prefix="period." required>

<Description>

Inclusive start of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant rounded to the hour on the hour grain.

</Description>

</Field>

<Field name="to" type="string" prefix="period." required>

<Description>

Inclusive end of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant rounded to the hour on the hour grain.

</Description>

</Field>

<Field name="grain" type="string" prefix="period." required>

<Description>

The bucket grain of the series, either `day` or `hour`.

</Description>

</Field>

<Field name="data_as_of" type="nullable string" prefix="period.">

<Description>

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 rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="data" type="array of object" required>

<Description>

One row per bucket (day or hour, per the grain) in the period, in chronological order. Buckets with no activity are included with zero counts.

</Description>

<FieldChildren kind="response">

<Field name="bucket" type="string" prefix="data." required>

<Description>

The day (YYYY-MM-DD) or hour (RFC 3339, on the hour, UTC) this point covers, matching the period's grain.

</Description>

</Field>

<Field name="sends_accepted" type="integer" prefix="data." required>

<Description>

Distinct email messages accepted in this bucket, counted at the message level (one per accepted send regardless of how many recipients it addresses). Every other metric in `delivery` and `engagement` is recipient-level or event-level.

</Description>

</Field>

<Field name="delivery" type="object" prefix="data." required>

<FieldChildren kind="response">

<Field name="accepted" type="integer" prefix="data.delivery.">

<Description>

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.

</Description>

</Field>

<Field name="processed" type="integer" prefix="data.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="delivered" type="integer" prefix="data.delivery." required>

<Description>

Distinct recipients whose message the receiving mail server accepted.

</Description>

</Field>

<Field name="bounced" type="integer" prefix="data.delivery." required>

<Description>

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.

</Description>

</Field>

<Field name="bounces" type="object" prefix="data.delivery." required>

<FieldChildren kind="response">

<Field name="hard" type="integer" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="soft" type="integer" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="admin" type="integer" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="block" type="integer" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="undetermined" type="integer" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="hard_rate" type="nullable number" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="soft_rate" type="nullable number" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="admin_rate" type="nullable number" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="block_rate" type="nullable number" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

<Field name="undetermined_rate" type="nullable number" prefix="data.delivery.bounces." required>

<Description>

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

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="complained" type="integer" prefix="data.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="deferred" type="integer" prefix="data.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="rejected" type="integer" prefix="data.delivery." required>

<Description>

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.

</Description>

</Field>

<Field name="oob_bounces" type="integer" prefix="data.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="effective_delivered" type="integer" prefix="data.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="all_bounces" type="integer" prefix="data.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="oob_rate" type="nullable number" prefix="data.delivery." required>

<Description>

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.

</Description>

</Field>

<Field name="delivery_rate" type="nullable number" prefix="data.delivery." required>

<Description>

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.

</Description>

</Field>

<Field name="bounce_rate" type="nullable number" prefix="data.delivery." required>

<Description>

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.

</Description>

</Field>

<Field name="complaint_rate" type="nullable number" prefix="data.delivery." required>

<Description>

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.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="engagement" type="object" prefix="data." required>

<FieldChildren kind="response">

<Field name="opens" type="integer" prefix="data.engagement." required>

<Description>

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

</Description>

</Field>

<Field name="opens_non_prefetched" type="integer" prefix="data.engagement." required>

<Description>

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.

</Description>

</Field>

<Field name="unique_opens" type="integer" prefix="data.engagement." required>

<Description>

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

</Description>

</Field>

<Field name="unique_opens_non_prefetched" type="integer" prefix="data.engagement." required>

<Description>

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.

</Description>

</Field>

<Field name="clicks" type="integer" prefix="data.engagement." required>

<Description>

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

</Description>

</Field>

<Field name="unique_clicks" type="integer" prefix="data.engagement." required>

<Description>

Distinct recipients who clicked at least once.

</Description>

</Field>

<Field name="unsubscribes" type="integer" prefix="data.engagement." required>

<Description>

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

</Description>

</Field>

<Field name="open_rate" type="nullable number" prefix="data.engagement." required>

<Description>

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.

</Description>

</Field>

<Field name="click_rate" type="nullable number" prefix="data.engagement." required>

<Description>

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.

</Description>

</Field>

<Field name="unsubscribe_rate" type="nullable number" prefix="data.engagement." required>

<Description>

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.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="latency" type="object" prefix="data." required>

<FieldChildren kind="response">

<Field name="processing" type="object" prefix="data.latency.">

<Description>

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.

</Description>

<FieldChildren kind="response">

<Field name="p50_ms" type="nullable integer" prefix="data.latency.processing." required>

<Description>

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

</Description>

</Field>

<Field name="p95_ms" type="nullable integer" prefix="data.latency.processing." required>

<Description>

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

</Description>

</Field>

<Field name="p99_ms" type="nullable integer" prefix="data.latency.processing." required>

<Description>

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

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="delivery" type="object" prefix="data.latency.">

<Description>

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.

</Description>

<FieldChildren kind="response">

<Field name="p50_ms" type="nullable integer" prefix="data.latency.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="p95_ms" type="nullable integer" prefix="data.latency.delivery." required>

<Description>

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

</Description>

</Field>

<Field name="p99_ms" type="nullable integer" prefix="data.latency.delivery." required>

<Description>

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

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="total" type="object" prefix="data.latency.">

<Description>

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.

</Description>

<FieldChildren kind="response">

<Field name="p50_ms" type="nullable integer" prefix="data.latency.total." required>

<Description>

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

</Description>

</Field>

<Field name="p95_ms" type="nullable integer" prefix="data.latency.total." required>

<Description>

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

</Description>

</Field>

<Field name="p99_ms" type="nullable integer" prefix="data.latency.total." required>

<Description>

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

</Description>

</Field>

</FieldChildren>

</Field>

</FieldChildren>

</Field>

</FieldChildren>

</Field>

</Payload>