Sign in

v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Domains

Get domain health

The domain's deliverability health in one FREE read: a verdict (healthy / at_risk / critical) with actionable signals, DNS/auth state incl. DMARC, active percentage-based gradual sends + recent UTC-day volume, general bounce/complaint reporting, workspace reputation, and inbox-placement history. No bounce or complaint threshold is attached to a gradual-send configuration.

get/v1/domains/{domainId}/health

Path parameters

domainIdstring required

Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.

Example:kx7bkh53hasmfeh5kd7sqgykt187g8ww

Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.

Response

The aggregate health report.

domainIdstring required
namestring required
status'not_started' | 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'partially_verified' | 'partially_failed' required
sendableboolean required
verdict'healthy' | 'at_risk' | 'critical' required
checkedAtstring date-time required