Skip to content

mail_stats_get

Dashboard aggregation for the product over 7d|30d|90d: sent/delivered/bounced/complained totals, period-over-period deltas, daily volume buckets, and deliverability percentages

Tool

mail_stats_get

Dashboard aggregation for the product over 7d|30d|90d: sent/delivered/bounced/complained totals, period-over-period deltas, daily volume buckets, and deliverability percentages

Dashboard aggregation for the product over 7d|30d|90d: sent/delivered/bounced/complained totals, period-over-period deltas, daily volume buckets, and deliverability percentages

Behavior

HTTP
GET /mail/stats

Arguments

Name
Type
Required
Description
period
string
—
Rolling window the aggregation covers, ending now. Defaults to 30d.

Response

Field
Type
Always
Description
range
object
•
The absolute instants the period resolved to
deltas
object
•
Percent change of each total against the immediately preceding window of the same length
period
string
•
The window these numbers cover — the echo of the requested period
totals
object
•
Counts over the window
volume
array
•
One bucket per UTC day in the window, oldest first
deliverability
object
•
The three rates senders are judged on, as percentages of sent

Try it

Dashboard aggregation for the product over 7d|30d|90d: sent/delivered/bounced/complained totals, period-over-period deltas, daily volume buckets, and deliverability percentages.

When to use

Dashboard aggregation for the product over 7d|30d|90d: sent/delivered/bounced/complained totals, period-over-period deltas, daily volume buckets, and deliverability percentages

Example

Ask your agent something like this:

Dashboard aggregation for the product over 7d|30d|90d: sent/delivered/bounced/complained totals, period-over-period deltas, daily volume buckets, and deliverability percentages.

The agent will invoke mail_stats_get with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select