Skip to Content

Get daily account usage metrics.

Returns daily storage, message counts, and API request meter metrics for an account over a UTC date range.

openemail.accounts.getUsage(
  accountId: string,
  options?: AccountsGetUsageOptions,
): ApiPromise<AccountUsage>

It calls GET /accounts/{accountId}/usage: Get daily account usage metrics in the API reference.

Example

const accountUsage = await openemail.accounts.getUsage(accountId)

Arguments

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

Options

The last argument, options, a AccountsGetUsageOptions, takes:

OptionTypeSent asDescription
fromstringquery fromFirst UTC day in YYYY-MM-DD format (default: 29 days ago)
tostringquery toLast UTC day in YYYY-MM-DD format (default: today)
requestsbooleanquery requestsSet to 'true' to include detailed API request count breakdown by resource and principal

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

Errors

StatusWhat it means
400validation_failed (malformed or inverted range, or exceeds 400 days)
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
503temporary_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: AccountUsage.