Stats (domain)

GET/api/v1/domains/stats
Requires anorganization API keywith the scopedomains:read

Request

GET/api/v1/domains/stats
curl -X GET 'https://app.mailyte.com/api/v1/domains/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
    • objectstringdomain_stats
    • totalinteger

      Every domain this organization holds that is not deleted or hidden.

    • activeinteger

      Domains marked active. Counted from a different column than a domain's published `state`, so the two can disagree.

    • inactiveinteger

      Domains not yet marked active -- usually awaiting DNS.

    • dns_failedinteger

      Domains whose last DNS check failed. This OVERLAPS `inactive`: the three counts do not sum to `total`.

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.