Overview a domain

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/overview' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/overview', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/domains/yourdomain.com/overview",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/domains/yourdomain.com/overview');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/overview")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringdomain_overview
  • domain_idstring
  • namestring

    The domain itself, e.g. `example.com`.

  • statestringactive | provisioning | failed | disabled

    The same lifecycle answer `GET /domains/{domain}` publishes, derived from the same fields.

  • sendingobject

    Identical to `sending` on the domain itself.

    • enabledboolean
    • requiresarray<string>
  • receivingobject

    Identical to `receiving` on the domain itself.

    • enabledboolean
    • requiresarray<string>
  • mailboxesobject

    Live counts over this domain's mailbox rows. None of the three is ever null, and `active` + `suspended` need not sum to `total` -- a mailbox in any other status is counted only in `total`.

    • totalinteger

      Mailboxes on this domain. A live `COUNT`, never null; 0 means the domain genuinely has none.

    • activeinteger

      Of those, how many are active. A live `COUNT`, never null; 0 is a measured zero.

    • suspendedinteger

      Of those, how many are suspended. A live `COUNT`, never null; 0 is a measured zero, not an unread figure.

  • storageobject
    • used_percentnumber

      Storage used across this domain's mailboxes as a percentage of the domain quota. Null when no quota is set -- there is nothing to be a percentage of.

  • health_scoreinteger

    0-100. The same score `GET /domains/{domain}/health` returns, where the issues behind it are also listed. Never null: it is computed on every request by deducting from 100 for each problem found, so a domain with nothing wrong scores 100 and one that could not be judged still scores. A low score is a verdict, never a missing reading.

  • checked_atstring

    When DNS was last resolved for this domain. Null when it never has been.

  • created_atstring

Returned inside the standard envelope.

Errors

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