accounts.getTraffic
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.
openemail.accounts.getTraffic(
accountId: string,
options?: AccountsGetTrafficOptions,
): ApiPromise<AccountTraffic>It calls GET /accounts/{accountId}/traffic: Get account traffic statistics in the API reference.
Example
const accountTraffic = await openemail.accounts.getTraffic(accountId)Arguments
| Argument | Type | Description |
|---|---|---|
accountId | string | Account ULID identifier. The path's {accountId}. |
Options
The last argument, options, a AccountsGetTrafficOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
range | ('1h' | '6h' | '24h' | '7d' | '30d') | query range | Time window range ('1h', '6h', '24h', '7d', '30d') |
mailboxId | string | query mailboxId | Narrow the aggregate to a single mailbox ULID |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, AccountTraffic. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed — unknown range value |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Account not found or not accessible to this principal |
502 | analytics_query_failed |
503 | analytics_unavailable. Or temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
It names these types of the API, each on a page of its own: AccountTraffic.