Analytics a domain
/api/v1/domains/{domain}/analyticsParameters
| Name | In | Type | Description |
|---|---|---|---|
domainrequired | path | string | The domain id, or the domain name itself. |
Request
/api/v1/domains/{domain}/analyticscurl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/analytics' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/analytics', {
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/analytics",
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/analytics');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/analytics")
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.
dataobjectobjectstringdomain_analyticsdomain_idstringperiodobjectDefaults to the last 30 days. Both bounds are inclusive.
start_datestringend_datestring
seriesobjectemails_sentarray<object>Messages accepted for delivery. One point per day in the window, including days with no data.
datestringvaluenumberA 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.
datestringvaluenumberA 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.
datestringvaluenumberA 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.
datestringvaluenumberA 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.
datestringvaluenumberA 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
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The 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. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too 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.