Health a domain
GET
/api/v1/domains/{domain}/healthParameters
| Name | In | Type | Description |
|---|---|---|---|
domainrequired | path | string | The domain id, or the domain name itself. |
Request
GET
/api/v1/domains/{domain}/healthcurl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/health' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/health', {
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/health",
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/health');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/health")
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_healthdomain_idstringstatusstringgood | warning | criticalBanded from
score: good at 90 and above, warning at 60, critical below it.scoreinteger0-100.
issuesarray<object>Every problem found, each with its own fix. Empty when there are none.
issuestringrecommendationstringWhat to do about this issue.
metricsobjectThe last 30 days.
emails_sentintegerMessages accepted for delivery in the last 30 days. 0 means none are recorded; the rates are then null.
delivery_ratenumberPercentage of sent mail confirmed delivered. Null when nothing was sent in the window.
bounce_ratenumberPercentage of sent mail that bounced. Null when nothing was sent in the window.
spam_ratenumberPercentage of sent mail reported as spam. Null when nothing was sent in the window.
checked_atstringWhen DNS was last resolved for this domain. Null when it never has been.
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.