Stats a email account

GET/api/v1/email-accounts/{account}/stats
Requires anorganization API keywith the scopemailboxes:read

Parameters

NameInTypeDescription
accountrequiredpathstringThe account identifier.

Request

GET/api/v1/email-accounts/{account}/stats
curl -X GET 'https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/stats' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • objectstringmailbox_stats
    • mailbox_idstring

      The mailbox these counters describe. Retrieve it with GET /api/v1/email-accounts/{email_account}.

    • messagesobject

      Five independent answers about one set of messages. **total is not sent + received**: a message can be counted in both unread and starred, and total counts rows. Do not expect these to add up.

      • totalinteger
      • sentinteger
      • receivedinteger
      • unreadinteger
      • starredinteger
    • storageobject

      Storage in bytes, as storage on the mailbox. For a percentage, divide used_bytes by quota_bytes.

      • quota_bytesinteger

        The mailbox's storage limit, in bytes. Always set.

      • used_bytesinteger

        Bytes used. Null means we could not read it yet, not that the mailbox is empty.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.