Skip to content

tracking_domains_get

Get one tracking-host binding and its status

Tool

tracking_domains_get

Get one tracking-host binding and its status

Get one tracking-host binding and its status

Behavior

HTTP
GET /tracking/domains/:bindingId

Arguments

Name
Type
Required
Description
bindingId
string
•
Id of the tracking-host binding to act on, as returned in `bindings[].bindingId` by tracking_domains_list

Response

Field
Type
Always
Description
host
string
•
Fully-qualified tracking host this binding serves, e.g. analytics.example.com
status
string
•
Where the claim stands: `pending` while DNS has not been observed live, `active` once it serves, `failed` when the check gave up
records
array
•
DNS records the platform expects to see published for this host, as returned when the binding was claimed
domainId
string
•
Product domain this tracking host sits under
bindingId
string
•
Id of the tracking-host binding to act on, as returned in `bindings[].bindingId` by tracking_domains_list
createdAt
string
•
When the binding was claimed
productId
string
•
Product the binding belongs to
updatedAt
string
•
When the binding last changed status or records
statusDetail
string
•
Human-readable reason behind the current status, such as the DNS error that made it fail; null while there is nothing to report
ownerExtension
string
•
Extension that claimed the binding; tracking bindings are owned by this toolkit

Try it

Get one tracking-host binding and its status.

When to use

Get one tracking-host binding and its status

Example

Ask your agent something like this:

Get one tracking-host binding and its status.

The agent will invoke tracking_domains_get with these arguments:

{
  "bindingId": "<bindingId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select