Get custom tracking status
Returns the custom tracking state for a sending domain: lifecycle status, the required DNS records, certificate and CAA readiness, and any scheduled teardown.
GET
Returns the custom tracking state for a sending domain: lifecycle status, the required DNS records, certificate and CAA readiness, and any scheduled teardown. enabled is false when no custom tracking domain is provisioned.
apiKeyheader
x-api-key<token>id*stringMatch
^dom_[0-9a-hjkmnp-tv-z]{16,24}$CustomTrackingStatus
application/json- response
enabled*booleancustomTracking*|nullparentDomains*array<string>import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.getCustomTracking({ "id": "example"});Example Response
{ "enabled": true, "customTracking": { "status": "pending", "label": "string", "hostname": "string", "parentDomain": "string", "region": "string", "sslStatus": "string", "certificate": { "reason": { "code": "initializing", "message": "string" }, "lastCheckedAt": "string", "nextCheckAt": "string" }, "dnsRecords": { "tracking": { "name": "string", "type": "string", "value": "string" }, "dcvDelegation": { "name": "string", "type": "string", "value": "string" } }, "caaBlocked": true, "verificationErrors": [ "string" ], "teardownScheduledAt": "string" }, "parentDomains": [ "string" ]}