Email deliverability stats
GET/api/v1/email/stats
GET /email/stats
curl -X GET 'https://www.unitpost.com/api/v1/email/stats' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'User-Agent: my-app/1.0'Response · 200
{
"windowDays": 0,
"clampedToRetentionDays": 0,
"totals": {
"sent": 0,
"delivered": 0,
"opened": 0,
"clicked": 0,
"bounced": 0,
"complained": 0,
"failed": 0
},
"rates": {
"delivery": 0,
"open": 0,
"click": 0,
"bounce": 0,
"complaint": 0
}
}Retrieve aggregate deliverability and engagement metrics for your workspace over a rolling window. You get totals (sent, delivered, opened, clicked, bounced, complained, failed) alongside the rates that matter — delivery, open, click, bounce, and complaint. Open and click rates count only emails where that tracking was enabled, so turning tracking off for transactional mail won't skew them. Control the window with the days parameter (1–365, default 30). For the individual emails behind these numbers, see List sent emails. Requires the emails:read capability.
Parameters1 field
| Field | Type | Description |
|---|---|---|
days | integer · query | Window size in days (1–365). Defaults to 30; values above 365 are rejected. |
Response · 200 fields4 fields
| Field | Type | Description |
|---|---|---|
windowDaysrequired | integer | The rolling window, in days. |
clampedToRetentionDays | integer | Non-null when the requested window exceeded the plan's log retention and was clamped to this many days (data past the retention horizon is purged). |
totalsrequired | object | — |
ratesrequired | object | Percentages (one decimal). delivery/bounce/complaint are vs sent; open/click are vs delivered. |
200401403422