Usage
Get org-wide usage summary
Returns aggregated email sending statistics for your entire organization. For per-tenant breakdown, use GET /usage/tenants.
Use cases:
- Platform dashboards showing org-wide metrics
- Quick health check on overall sending
- Monitoring total volume and delivery rates
Response includes:
- emails - Aggregated email counts across all tenants
- rates - Overall delivery and bounce rates
- tenants - Tenant count summary (total, active, with activity)
Related endpoints:
- GET /usage/tenants - Paginated usage per tenant
- GET /usage/export - Export usage data for billing
- GET /tenants/{tenantId}/usage - Single tenant usage details
- GET /limits - Rate limits and send limits
get/usage
Query parameters
periodstring
Time period for usage data.
Shortcuts: today, yesterday, this_week, last_week, this_month, last_month, last_7_days, last_30_days, last_90_days
Month format: 2024-01 (YYYY-MM)
Custom range: 2024-01-01..2024-01-15
timezonestring
Timezone for period calculations (IANA format)
Response
Org-wide usage summary
Example response
{
"data": {
"period": {
"start": "2024-01-01T00:00:00.000Z",
"end": "2024-01-31T23:59:59.999Z"
},
"emails": {
"sent": 10000,
"delivered": 9700,
"soft_failed": 100,
"hard_failed": 50,
"bounced": 100,
"held": 50
},
"rates": {
"delivery_rate": 0.97,
"bounce_rate": 0.015
},
"tenants": {
"total": 25,
"active": 20,
"withActivity": 18
}
},
"meta": {
"requestId": "req_V1StGXR8_Z5jdHi6"
}
}