Analytics a domain

GET/api/v1/domains/{domain}/analytics
Requires anorganization API keywith the scopereports:read

Parameters

NameInTypeDescription
domainrequiredpathstringThe domain id, or the domain name itself.

Request

GET/api/v1/domains/{domain}/analytics
curl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/analytics' \
  -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_analytics
    • domain_idstring
    • periodobject

      Defaults to the last 30 days. Both bounds are inclusive.

      • start_datestring
      • end_datestring
    • seriesobject
      • emails_sentarray<object>

        Messages accepted for delivery. One point per day in the window, including days with no data.

        • datestring
        • valuenumber

          A count, never null: every day in the window is present, and a day with no recorded events is written as 0 rather than left out. Read that 0 as "nothing was recorded", not as proof that nothing happened.

      • emails_receivedarray<object>

        Messages delivered to this domain. One point per day in the window, including days with no data.

        • datestring
        • valuenumber

          A count, never null: every day in the window is present, and a day with no recorded events is written as 0 rather than left out. Read that 0 as "nothing was recorded", not as proof that nothing happened.

      • delivery_ratearray<object>

        Delivered as a share of sent, per day. One point per day in the window, including days with no data.

        • datestring
        • valuenumber

          A percentage. Null on a day with no sends -- there is no rate without a denominator.

      • bounce_ratearray<object>

        Bounced as a share of sent, per day. One point per day in the window, including days with no data.

        • datestring
        • valuenumber

          A percentage. Null on a day with no sends.

      • spam_complaintsarray<object>

        Spam reports and delivery complaints. One point per day in the window, including days with no data.

        • datestring
        • valuenumber

          A count, never null: every day in the window is present, and a day with no recorded events is written as 0 rather than left out. Read that 0 as "nothing was recorded", not as proof that nothing happened.

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.