Get email stats
get_email_statsRead-onlyIdempotent
Account-level email deliverability stats (counts, rates, time series).
Instructions
Account-level email deliverability stats (counts, rates, time series).
Aggregates across your whole organization's outbound mail over a
window — use this for "how's deliverability doing" rather than
one message's history (``get_email_events`` covers that).
``from_`` / ``to`` are ISO 8601 timestamps (defaults: last 7 days
ending now). ``bucket`` is ``"day"`` (default) or ``"hour"`` —
``"hour"`` is limited to an 8-day span; any range is capped at 92
days.
Returns ``{"from": ..., "to": ..., "bucket": ..., "totals": {...},
"rates": {...}, "series": [...]}`` — ``totals``/each ``series``
bucket carry counts (sent, delivered, bounced, opened, ...) and
``rates`` carries derived ratios (delivery, bounce, open, click),
each ``None`` when ``totals.sent`` is 0. Open and click numbers
only count HTML emails. Plain-text-only emails are never tracked
for opens or clicks, so they lower those rates. On failure returns
``{"error": "<message>"}`` instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | ||
| from_ | No | ||
| bucket | No | day |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||