Skip to main content
GET
Get domain health

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

domainId
string
required

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

Required string length: 1 - 64
Example:

"kx7bkh53hasmfeh5kd7sqgykt187g8ww"

Response

The aggregate health report.

domainId
string
required
Required string length: 1 - 64
name
string
required
Required string length: 1 - 253
status
enum<string>
required
Available options:
not_started,
pending,
verified,
failed,
temporary_failure,
partially_verified,
partially_failed
sendable
boolean
required
verdict
enum<string>
required
Available options:
healthy,
at_risk,
critical
score
object
required
authentication
object
required
tracking
object
required
warmup
object[]
required
dailyVolume
object[]
required
domainActivity
object | null
required
orgReputation
object | null
required
recentPlacementTests
object[]
required
signals
object[]
required
checkedAt
string<date-time>
required