Skip to main content
GET
/
domains
/
{id}
/
deliverability
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/domains/{id}/deliverability \
  --header 'Authorization: Bearer <token>'
{
  "domain": "<string>",
  "sent": 1,
  "delivered": 1,
  "bounced": 1,
  "complained": 1,
  "bounceRate": 1,
  "complaintRate": 1,
  "isHealthy": true
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

​
id
string
required

Unique domain identifier

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

OK

Email deliverability statistics for a domain

​
domain
string
required

Domain these statistics apply to

​
sent
integer
required

Total number of emails sent

Required range: x >= 0
​
delivered
integer
required

Number of emails successfully delivered

Required range: x >= 0
​
bounced
integer
required

Number of emails that bounced

Required range: x >= 0
​
complained
integer
required

Number of emails marked as spam by recipients

Required range: x >= 0
​
bounceRate
number
required

Bounce rate as a decimal (e.g. 0.02 for 2%)

Required range: x >= 0
​
complaintRate
number
required

Complaint rate as a decimal (e.g. 0.001 for 0.1%)

Required range: x >= 0
​
isHealthy
boolean
required

Whether deliverability metrics are within acceptable thresholds