API reference / Operations by tag

domains

Tracking domains: DNS wizard, verification, SSL and health.

11 operations. Base URL https://api.metrixed.com/v1; see authentication, errors and pagination.

Operations

Method	Path	Summary
GET	`/tracking-domains`	List TrackingDomains
POST	`/tracking-domains`	Create TrackingDomain
GET	`/tracking-domains/{id}`	Get TrackingDomain
PATCH	`/tracking-domains/{id}`	Update TrackingDomain
DELETE	`/tracking-domains/{id}`	Delete TrackingDomain
GET	`/tracking-domains/{id}/dns`	DNS wizard: records to create (CNAME target per region, TXT verification token)
GET	`/tracking-domains/{id}/health`	Domain health: last 24h of 5-minute samples + summary
POST	`/tracking-domains/{id}/verify`	Trigger DNS/SSL verification
POST	`/tracking-domains/bulk/apply`	Bulk edit apply
POST	`/tracking-domains/bulk/preview`	Bulk edit preview
POST	`/tracking-domains/search`	Search TrackingDomains (advanced)

`GET /tracking-domains`

List TrackingDomains

Operation getTrackingDomains. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`page`	query	integer	no
`page_size`	query	integer	no
`sort`	query	string	no	field or -field
`include`	query	string	no	comma-separated relationships
`filter`	query	object (free-form)	no
`q`	query	string	no	free-text search

Status	Description	Body
200	ok	application/json TrackingDomainList
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/tracking-domains?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}

`POST /tracking-domains`

Create TrackingDomain

Operation postTrackingDomains. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): TrackingDomainCreate

Field	Type	Flags	Description
`host`	string	required
`protocol`	string
`type`	enum: `click`, `impression`, `conversion_pixel`, `landing`, `partner_portal`, `advertiser_portal`, `admin_portal`, `unilink`
`visibility`	string
`partner_ids`	array of string
`is_default`	boolean
`ssl_mode`	enum: `auto_acme`, `cloudflare_saas`, `custom_cert`
`is_ssl_forced`	boolean
`legacy_style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`legacy_id_map`	object (free-form)		old id -> new id
`health`	object (free-form)
`region`	string
`verification`	object (free-form)		verify result: status, reason, cname_ok, txt_ok (verify only)
`dns_records`	array of object (free-form)

Status	Description	Body
201	ok	application/json TrackingDomain
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/tracking-domains' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"host":""}'

Example 201 response:

json

{
  "external_ref": ""
}

`GET /tracking-domains/{id}`

Get TrackingDomain

Operation getTrackingDomainsId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json TrackingDomain
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/tracking-domains/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "external_ref": ""
}

`PATCH /tracking-domains/{id}`

Update TrackingDomain

Operation patchTrackingDomainsId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Request body (application/json, required): TrackingDomainUpdate

Field	Type	Description
`host`	string
`protocol`	string
`type`	enum: `click`, `impression`, `conversion_pixel`, `landing`, `partner_portal`, `advertiser_portal`, `admin_portal`, `unilink`
`visibility`	string
`partner_ids`	array of string
`is_default`	boolean
`ssl_mode`	enum: `auto_acme`, `cloudflare_saas`, `custom_cert`
`is_ssl_forced`	boolean
`legacy_style`	enum: `native`, `numeric`, `trackier`, `everflow`, `tune`, `affise`, `cake`, `app`
`legacy_id_map`	object (free-form)	old id -> new id
`health`	object (free-form)
`region`	string
`verification`	object (free-form)	verify result: status, reason, cname_ok, txt_ok (verify only)
`dns_records`	array of object (free-form)

Status	Description	Body
200	ok	application/json TrackingDomain
default	error	application/json Error

bash

curl -X PATCH 'https://api.metrixed.com/v1/tracking-domains/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"host":"","protocol":"","type":"click","visibility":""}'

Example 200 response:

json

{
  "external_ref": ""
}

`DELETE /tracking-domains/{id}`

Delete TrackingDomain

Operation deleteTrackingDomainsId. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
204	ok	application/json Ok
default	error	application/json Error

bash

curl -X DELETE 'https://api.metrixed.com/v1/tracking-domains/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

json

{
  "ok": false
}

`GET /tracking-domains/{id}/dns`

DNS wizard: records to create (CNAME target per region, TXT verification token)

Operation getTrackingDomainsIdDns. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json DomainDns
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/tracking-domains/<id>/dns' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "host": "",
  "status": "",
  "region": "",
  "ssl_mode": ""
}

`GET /tracking-domains/{id}/health`

Domain health: last 24h of 5-minute samples + summary

Operation getTrackingDomainsIdHealth. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json DomainHealth
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/tracking-domains/<id>/health' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "domain_id": "",
  "host": "",
  "status": "",
  "status_reason": ""
}

`POST /tracking-domains/{id}/verify`

Trigger DNS/SSL verification

Operation postTrackingDomainsIdVerify. Auth: API key (Bearer) or session cookie.

Parameter	In	Type	Required	Description
`id`	path	string	yes

Status	Description	Body
200	ok	application/json TrackingDomain
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/tracking-domains/<id>/verify' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "external_ref": ""
}

`POST /tracking-domains/bulk/apply`

Bulk edit apply

Operation postTrackingDomainsBulkApply. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/tracking-domains/bulk/apply' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /tracking-domains/bulk/preview`

Bulk edit preview

Operation postTrackingDomainsBulkPreview. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): BulkPatch

Field	Type	Flags	Description
`ids`	array of string	required
`patches`	array of object	required

Status	Description	Body
200	ok	application/json BulkPreview
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/tracking-domains/bulk/preview' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[""],"patches":[{"field":"","value":{}}]}'

Example 200 response:

json

{
  "affected": 0,
  "changes": [
    {}
  ],
  "warnings": [
    ""
  ],
  "token": ""
}

`POST /tracking-domains/search`

Search TrackingDomains (advanced)

Operation postTrackingDomainsSearch. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): SearchRequest

Field	Type	Flags	Description
`filters`	array of object
`search`	string
`sort`	array of object (free-form)
`page`	integer
`page_size`	integer
`include`	array of string

Status	Description	Body
200	ok	application/json TrackingDomainList
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/tracking-domains/search' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filters":[{}],"search":"","sort":[{}],"page":0}'

Example 200 response:

json

{
  "data": [
    {}
  ],
  "page": {}
}