List deliverabilitys

GET/api/v1/deliverability

Requires anorganization API keywith the scopereports:read

Request

GET/api/v1/deliverability

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

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

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

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/deliverability")
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) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- objectstringdeliverability_report
- scoreinteger
  0-100.
- bandstringneeds_attention | good | excellent
  The score's band, as a fixed value to branch on.
- window_daysinteger
  Everything in this report is computed over this many days, ending now.
- volumeobject
  Counts of what happened.
  - submittedinteger
    Messages sent. Mail to reserved test domains (.invalid, .test, .example, .localhost, example.com) is not counted here or below.
  - deliveredinteger
    Distinct MESSAGES delivered, not delivery events.
  - bouncedinteger
    Messages the recipient's server refused, counted once each. Routing loops are counted separately in routing_loops.
  - routing_loopsinteger
    Messages lost to a mail routing loop (5.4.6). This is a fault on our side, not a bad address: report it to us, and do not remove the contact.
  - openedinteger
  - clickedinteger
  - complaintsinteger
    delivery.complaint events.
  - unsubscribedinteger
- ratesobject
  Percentages from 0 to 100, not fractions: a bounce rate of 50 means half.
  - opennumber
  - clicknumber
  - bouncenumber
  - negative_engagementnumber
    Complaints and unsubscribes together.
- authenticationobject
  SPF, DKIM and DMARC for each domain. Domains hidden on the Domains page are left out here, but their mail is still counted in volume.
  - average_scorenumber
    0-100.
  - domainsarray<object>
    - domainstring
      The domain these checks are about.
    - scoreinteger
      0-100.
    - spfboolean
    - dkimboolean
    - dmarcboolean
- recommendationsarray<object>
  What to fix, worst first. Empty when there is nothing to say.
  - severitystringcritical | warning | info
  - messagestring
    The advice, for a person to read. Do not match on the text; branch on severity.

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.