Stats a domain

Parameters

Request

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

const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/stats', {
  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/stats",
    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/stats');

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

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/stats")
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_usage
  • domain_idstring
  • mailboxesobject

    Counted from the mailbox rows themselves at request time, not from a rollup, so these two are never stale and never unknown.

    • totalinteger

      Mailboxes on this domain. A live `COUNT`, so it is never null and 0 means the domain genuinely has none.

    • activeinteger

      Of those, how many are active. A live `COUNT`, never null; 0 means none are active, which on a domain with mailboxes is a real finding rather than a missing reading.

  • storageobject
    • used_bytesinteger

      Bytes, summed across this domain's mailboxes. Never null: it is a `SUM` over rows this API owns, and a domain with no mailboxes sums to a genuine 0.

    • quota_bytesinteger

      Bytes. The same value as `limits.storage_bytes` on the domain, and never null for the same reason -- the column is NOT NULL. **0 means no quota is enforced**; that is how "unlimited" is said here, not null.

  • todayobject

    Since midnight UTC.

    • emails_sentinteger

      Messages accepted for delivery since midnight UTC. Never null -- it is read from the daily rollup, which answers 0 for a day it holds no rows for. **So 0 means "the rollup records nothing today", which is not the same as proof that nothing was sent**: a rollup that has not run yet reports the same 0. Treat it as a lower bound, and do not bill from it.

    • emails_receivedinteger

      Messages delivered to this domain since midnight UTC. Never null, and 0 carries the same caveat as `emails_sent`: it is the absence of recorded events, not measured silence.

    • delivery_ratenumber

      Percentage. Null when nothing was sent today -- there is no rate without a denominator.

    • bounce_ratenumber

      Percentage. Null when nothing was sent today.

Returned inside the standard envelope.

Errors

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