accounts.getUsage
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
| Argument | Type | Description |
|---|---|---|
accountId | string | Account ULID identifier. The path's {accountId}. |
Options
The last argument, options, a AccountsGetUsageOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
from | string | query from | First UTC day in YYYY-MM-DD format (default: 29 days ago) |
to | string | query to | Last UTC day in YYYY-MM-DD format (default: today) |
requests | boolean | query requests | Set 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
| Status | What it means |
|---|---|
400 | validation_failed (malformed or inverted range, or exceeds 400 days) |
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 |
503 | 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: AccountUsage.