Get domain forwarding rate limit usage
Returns outbound email forwarding rate limit consumption (for group expansions and redirects) over the rolling 24-hour window for a domain. For an SRS bounce-return domain the isolated bounce-return budget is reported separately as srsBounce.
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: [].
domain*stringDomain name (e.g. 'example.com')
Current forwarding limit usage and effective limits
application/json- response
burstWindowSeconds*integerWidth of one burst bucket in seconds (3600); the burst figures cover two of them
int64messages*integerNumber of distinct messages sent in the rolling 24-hour window, plus each accepted list post whose fan-out is still being delivered: the count the daily limit is checked against
int64messagesHour*integerDistinct messages in the BURST window — the current hourly bucket plus the previous one, so a burst stays visible for up to an hour after it ended
int64msgsPerDay*|Configured daily message limit (null = unlimited or unenforced)
int64msgsPerHour*|Configured hourly (burst) message limit (null = unlimited or unenforced)
int64rcptsPerDay*|Configured daily recipient limit (null = unlimited or unenforced)
int64rcptsPerHour*|Configured hourly (burst) recipient limit (null = unlimited or unenforced)
int64recipients*integerTotal recipient count sent to in the rolling 24-hour window, plus the recipients an accepted list post still holds for its fan-out: the count the daily limit is checked against
int64recipientsHour*integerRecipients in the BURST window (current + previous hourly bucket)
int64sendHold*|||The mailbox's own hold: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither
windowSeconds*integerDuration of the rate-limit window in seconds (e.g. 86400 for 24h)
int64srsBounce?The SRS bounce-return channel's own budget — present only when the domain carries the srs flag. Isolated from the forwarding budget above, because SRS-shaped mail is an unauthenticated trigger and must not be able to spend a tenant channel's allowance.
curl -X GET 'https://api.open.email/api/v1/domains/string/forward-usage'{
"burstWindowSeconds": 0,
"messages": 0,
"messagesHour": 0,
"msgsPerDay": 0,
"msgsPerHour": 0,
"rcptsPerDay": 0,
"rcptsPerHour": 0,
"recipients": 0,
"recipientsHour": 0,
"sendHold": "disabled",
"windowSeconds": 0,
"srsBounce": {
"messages": 0,
"msgsPerDay": 0
}
}Get domain traffic statistics GET
Returns aggregated email volume and bytes by outcome and route kind over a time window for a domain.
Query domain delivery event log GET
Returns paginated detailed delivery events and attempt history for a domain with filtering by time range, outcome, source, mailbox, or the prepared email that…