Skip to Content

Get account API call counts.

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 account's keys or for its mailboxes. Buckets are labelled, sized and aligned exactly as GET /accounts/{accountId}/traffic's for the same range. A sampled estimate; GET /accounts/{accountId}/usage carries the exact daily counts.

openemail.accounts.getRequests(
  accountId: string,
  options?: AccountsGetRequestsOptions,
): ApiPromise<AccountRequests>

It calls GET /accounts/{accountId}/requests: Get account API call counts in the API reference.

Example

const accountRequests = await openemail.accounts.getRequests(accountId)

Arguments

ArgumentTypeDescription
accountIdstringAccount ULID identifier. The path's {accountId}.

Options

The last argument, options, a AccountsGetRequestsOptions, takes:

OptionTypeSent asDescription
range('1h' | '6h' | '24h' | '7d' | '30d')query rangeTime window ('1h', '6h', '24h', '7d', '30d')

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, AccountRequests. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed — unknown range
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Account not found or not accessible to this principal
502analytics_query_failed
503analytics_unavailable: no analytics token or account id configured, or this deployment writes no API-call dataset. 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: AccountRequests.