Skip to main content
POST
Check a tracking domain now

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

trackingDomainId
string
required

The tracking domain's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Response

The tracking domain, as the check left it.

id
string
required
hostname
string
required

The hostname the tracked links go through, such as go.fernway.co.

status
enum<string>
required

pending_dns while it waits for its CNAME record or its certificate, verifying while the hostname is set up: it can pass through both more than once. Then active, the only state campaigns use it in. failed when it has not become active after about a day of checks, or when its setup was lost.

Available options:
pending_dns,
verifying,
active,
failed
dnsTarget
string
required

The value of the one CNAME record to add, the record whose name is hostname.

verifiedAt
string<date-time>

When it last became active. Absent until it first does.

lastCheckedAt
string<date-time>

When it was last checked. Absent before the first check.

createdAt
string<date-time>