Skip to content

Get Domain Report

GET
/deliverability/domain/{domain}/report

One domain’s deliverability: its mailboxes’ health, its placement, its verdict.

Keyed by domain NAME rather than by domain_id, matching the app - a report is about the reputation of a name, which outlives any one row.

Authorizations

Parameters

Path Parameters

domain
required

Sending domain name, e.g. acme-outreach.com

string
/^[A-Za-z0-9.\-]{1,253}$/

Sending domain name, e.g. acme-outreach.com

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string