Get account traffic statistics
Returns total aggregated email volume and bytes across all domains owned by an account. Pass mailboxId to narrow the same aggregate to one mailbox — the series a mailbox overview charts. That dimension was added to the analytics write later than the rest, so a mailbox-scoped window covers traffic recorded since; GET /domains/{domain}/events (or /accounts/{accountId}/events) with the same filter remains the authoritative log.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
accountId*stringAccount ULID identifier
range?stringTime window range ('1h', '6h', '24h', '7d', '30d')
"24h""1h""6h""24h""7d""30d"mailboxId?stringNarrow the aggregate to a single mailbox ULID
length <= 64Counts and bytes summed across all domains owned by this account
application/json- response
accountId*stringAccount ID
byOutcome*Breakdown of event counts by outcome
domains*array<string>List of domain names included in this aggregate
domainsTruncated*booleanTrue if account owns more domains than query limit
estimated*booleanTrue if metrics are sampled estimates
mailboxId?stringPresent when the aggregate was narrowed to one mailbox
range*stringTime range of statistics
retentionDays*integerAnalytics retention window in days
rows*array<>Breakdown rows grouped by outcome and route kind
series?array<>Time-series buckets for charting
totals*curl -X GET 'https://api.open.email/api/v1/accounts/string/traffic'{
"accountId": "string",
"byOutcome": {
"property1": 0,
"property2": 0
},
"domains": [
"string"
],
"domainsTruncated": true,
"estimated": true,
"mailboxId": "string",
"range": "string",
"retentionDays": 0,
"rows": [
{
"bytes": 0,
"events": 0,
"outcome": "string",
"routeKind": "string"
}
],
"series": [
{
"bucket": "string",
"byOutcome": {
"property1": 0,
"property2": 0
},
"bytes": 0,
"bytesIn": 0,
"bytesOut": 0,
"events": 0,
"forwarded": 0,
"inbound": 0,
"outbound": 0
}
],
"totals": {
"bytes": 0,
"bytesIn": 0,
"bytesOut": 0,
"events": 0,
"forwarded": 0
}
}Get account receive allowance usage GET
Returns the inbound receive allowance's consumption (messages and bytes STORED in the rolling 24-hour window, across every mailbox the account owns), the…
Get account API call counts GET
Returns the API calls attributed to an account per time bucket, successes and failures alike: one per HTTP request plus one per JMAP method call, made with the…