Ctrlk
Dashboard
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tag

get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/{tagId}
GET /v1/tag/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
put
Authorizations
Path parameters
tagIdstringRequired
Body
namestringRequired
domainstringRequired
rootDomainstringRequired
debugbooleanRequired
currencyConversionstringRequired
sameSitestring · enumOptionalPossible values:
managedbooleanRequired
hostIdstringOptional
allowedEventsstringOptional
gpcbooleanRequired
cookieMapKeystringOptional
platformstring · enumRequiredPossible values:
idStorageMappingstringOptional
consentstring · enumOptionalPossible values:
currencyConversionTypestring · enumOptionalPossible values:
currencyProvidersstring[]Optional
skipZeroPurchaseEventbooleanOptional
greySwitchbooleanOptional
greySwitchEuUkbooleanOptional
strictOriginbooleanOptional
Responses
200

Successful

application/json
object · Model28Optional
put/tag/{tagId}
PUT /v1/tag/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "name": "text",
  "domain": "text",
  "rootDomain": "text",
  "debug": true,
  "currencyConversion": "text",
  "sameSite": "NONE",
  "managed": true,
  "hostId": "text",
  "allowedEvents": "text",
  "gpc": true,
  "cookieMapKey": "text",
  "platform": "EDGETAG",
  "idStorageMapping": "text",
  "consent": "DISABLED",
  "currencyConversionType": "OFF",
  "customCurrencyConversions": [
    {
      "from": "text",
      "to": "text",
      "value": 1
    }
  ],
  "currencyProviders": [
    "text"
  ],
  "skipZeroPurchaseEvent": true,
  "greySwitch": true,
  "greySwitchEuUk": true,
  "strictOrigin": true
}
{}
delete
Authorizations
Path parameters
tagIdstringRequired
Responses
200

Successful

application/json
object · Model28Optional
delete/tag/{tagId}
DELETE /v1/tag/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{}
get
Authorizations
Path parameters
tagIdstringRequired
Query parameters
dbIndexnumberRequired
Responses
200

Successful

application/json
statusstring · enumRequiredPossible values:
messagestringRequired
get/tag/d1-cleanup/{tagId}
GET /v1/tag/d1-cleanup/{tagId}?dbIndex=1 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "status": "success",
  "message": "text"
}
get
Authorizations
Path parameters
tagIdstringRequired
Responses
200

Successful

application/json
object · Model28Optional
get/tag/d1-migrate/{tagId}
GET /v1/tag/d1-migrate/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{}
get
Authorizations
Path parameters
tagIdstringRequired
Query parameters
allowEmptyScriptsbooleanOptional
Responses
200

Successful

application/json
domainstringRequired
get/tag/deploy/{tagId}
GET /v1/tag/deploy/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "records": [
    {
      "value": "text",
      "name": "text",
      "type": "text",
      "TTL": 1,
      "note": "text"
    }
  ],
  "domain": "text",
  "scripts": [
    {
      "providerId": "text"
    }
  ]
}
get
Authorizations
Path parameters
tagIdstringRequired
Query parameters
typestring · enumOptionalPossible values:
Responses
200

Successful

application/json
eventDropIdstringRequired
namestringRequired
typestringRequired
todaynumberRequired
yesterdaynumberRequired
lastWeeknumberRequired
createdAtstring · dateRequired
recoveryTimestring · dateRequired
get/tag/event_drop/{tagId}
GET /v1/tag/event_drop/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

[
  {
    "eventDropId": "text",
    "name": "text",
    "type": "text",
    "today": 1,
    "yesterday": 1,
    "lastWeek": 1,
    "createdAt": "2026-01-01",
    "recoveryTime": "2026-01-01"
  }
]
get
Authorizations
Path parameters
teamIdstringRequired
Responses
200

Successful

application/json
tagIdstringRequired
namestringRequired
domainstringRequired
debugbooleanRequired
sameSitestringRequired
sdkVersionstringRequired
edgeVersionstringRequired
managedbooleanRequired
deployedAtstring · dateRequired
get/tag/team/{teamId}
GET /v1/tag/team/{teamId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

[
  {
    "tagId": "text",
    "name": "text",
    "domain": "text",
    "debug": true,
    "sameSite": "text",
    "sdkVersion": "text",
    "edgeVersion": "text",
    "managed": true,
    "dnsRecords": [
      {
        "value": "text",
        "name": "text",
        "type": "text",
        "TTL": 1,
        "note": "text"
      }
    ],
    "deployedAt": "2026-01-01",
    "scripts": [
      {
        "scriptId": "text",
        "name": "text",
        "providerId": "text",
        "createdAt": "2026-01-01"
      }
    ],
    "host": {
      "name": "text",
      "type": "text",
      "hostId": "text"
    }
  }
]
get
Authorizations
Path parameters
tagIdstringRequired
Query parameters
eventstringRequired
rangenumberRequired
rangeTypestring · enumRequiredPossible values:
statusnumberRequired
timezonestringOptional
Responses
200

Successful

application/json
resultobject · Model28Optional
get/tag/analytics/event/{tagId}
GET /v1/tag/analytics/event/{tagId}?event=text&range=1&rangeType=DAY&status=1 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {}
}
get
Authorizations
Path parameters
tagIdstringRequired
Query parameters
typestring · enumRequiredPossible values:
rangeTypestring · enumRequiredPossible values:
statusnumberOptional
rangestringRequired
startRangestringRequired
endRangestringRequired
timezonestringOptional
Responses
200

Successful

application/json
get/tag/analytics/overview/{tagId}
GET /v1/tag/analytics/overview/{tagId}?type=status&rangeType=MINUTE&range=text&startRange=text&endRange=text HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {
    "string": {
      "string": 1
    }
  }
}
get
Authorizations
Path parameters
tagIdstringRequired
Query parameters
providerstringRequired
rangenumberRequired
rangeTypestring · enumRequiredPossible values:
statusnumberRequired
timezonestringOptional
Responses
200

Successful

application/json
resultobject · Model28Optional
get/tag/analytics/provider/{tagId}
GET /v1/tag/analytics/provider/{tagId}?provider=text&range=1&rangeType=DAY&status=1 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {}
}
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/all-time-metrics/{tagId}
GET /v1/tag/audience-sense/all-time-metrics/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/attribution/{tagId}
GET /v1/tag/audience-sense/attribution/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/channel-performance/{tagId}
GET /v1/tag/audience-sense/channel-performance/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/data-collected-from/{tagId}
GET /v1/tag/audience-sense/data-collected-from/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/overview/{tagId}
GET /v1/tag/audience-sense/overview/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/revenue-drivers/{tagId}
GET /v1/tag/audience-sense/revenue-drivers/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/tag/audience-sense/visitation/{tagId}
GET /v1/tag/audience-sense/visitation/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
get
Authorizations
Path parameters
tagIdstringRequired
Responses
200

Successful

application/json
messagestringOptional
validbooleanOptional
get/tag/verify/mapping/{tagId}
GET /v1/tag/verify/mapping/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "message": "text",
  "valid": true,
  "records": [
    {
      "value": "text",
      "name": "text",
      "type": "text",
      "TTL": 1,
      "note": "text"
    }
  ]
}
post
Authorizations
Body
namestringRequired
rootDomainstringRequired
debugbooleanRequired
sameSitestring · enumOptionalPossible values:
managedbooleanRequired
hostIdstringOptional
teamIdstringOptional
cookieMapKeystringOptional
platformstring · enumOptionalPossible values:
d1UserScalenumberOptional
tagTypestring · enumOptionalPossible values:
Responses
200

Successful

application/json
tagIdstringRequired
domainstringRequired
planstringOptional
post/tag
POST /v1/tag HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "name": "text",
  "rootDomain": "text",
  "debug": true,
  "sameSite": "NONE",
  "managed": true,
  "hostId": "text",
  "teamId": "text",
  "cookieMapKey": "text",
  "platform": "EDGETAG",
  "d1UserScale": 1,
  "tagType": "ECOMMERCE"
}
{
  "tagId": "text",
  "domain": "text",
  "plan": "text"
}
post
Authorizations
Path parameters
tagIdstringRequired
Body
modestring · enumRequiredPossible values:
Responses
200

Successful

application/json
object · Model28Optional
post/tag/mode/{tagId}
POST /v1/tag/mode/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "mode": "SINGLE"
}
{}
post
Authorizations
Path parameters
tagIdstringRequired
Body
enabledbooleanRequired
Responses
200

Successful

application/json
enabledbooleanRequired
previews_enabledbooleanRequired
post/tag/subdomain/{tagId}
POST /v1/tag/subdomain/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}
{
  "enabled": true,
  "previews_enabled": true
}
post
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
post/tag/{tagId}/id-graph-query
POST /v1/tag/{tagId}/id-graph-query HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
post
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
post/tag/{tagId}/reporting-query
POST /v1/tag/{tagId}/reporting-query HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
post
Authorizations
Path parameters
tagIdstringRequired
Body
pluginsOrderstring[]Optional
Responses
200

Successful

application/json
object · Model85Optional
post/tag/{tagId}/plugins-order
POST /v1/tag/{tagId}/plugins-order HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "pluginsOrder": [
    "text"
  ]
}
{}
post
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
post/tag/{tagId}/event-trail/query
POST /v1/tag/{tagId}/event-trail/query HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
put
Authorizations
Path parameters
tagIdstringRequired
Body
d1UserScalenumberOptional
d1UserCountnumberOptional
Responses
200

Successful

application/json
object · Model28Optional
put/tag/d1/{tagId}
PUT /v1/tag/d1/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "d1UserScale": 1,
  "d1UserCount": 1
}
{}
put
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
put/tag/segmentation/{tagId}
PUT /v1/tag/segmentation/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
put
Authorizations
Path parameters
tagIdstringRequired
Body
showDeleteRequestbooleanOptional
allowHyperscalerQuerybooleanOptional
Responses
200

Successful

application/json
object · Model28Optional
put/tag/settings/{tagId}
PUT /v1/tag/settings/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "showDeleteRequest": true,
  "allowHyperscalerQuery": true
}
{}
put
Authorizations
Path parameters
tagIdstringRequired
Body
emailsstring[] · min: 1Required
Responses
200

Successful

application/json
messagestringOptional
put/tag/share-dns/{tagId}
PUT /v1/tag/share-dns/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "emails": [
    "text"
  ]
}
{
  "message": "text"
}
put
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
put/admin/tag/configurator/{tagId}
PUT /v1/admin/tag/configurator/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
patch
Authorizations
Path parameters
tagIdstringRequired
Body
bindingsstringOptional
Responses
200

Successful

application/json
object · Model28Optional
patch/tag/bindings/{tagId}
PATCH /v1/tag/bindings/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "bindings": "text"
}
{}
patch
Authorizations
Path parameters
tagIdstringRequired
Body
customCodestringOptional
Responses
200

Successful

application/json
object · Model28Optional
patch/tag/custom-code/{tagId}
PATCH /v1/tag/custom-code/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "customCode": "text"
}
{}
patch
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
patch/tag/event-trail/{tagId}
PATCH /v1/tag/event-trail/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
patch
Authorizations
Responses
200

Successful

application/json
stringOptional
patch/tag/segmentation-promo/{tagId}
PATCH /v1/tag/segmentation-promo/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text
patch
Authorizations
Path parameters
tagIdstringRequired
Body
statusstring · enumRequiredPossible values:
Responses
200

Successful

application/json
object · Model28Optional
patch/tag/status/{tagId}
PATCH /v1/tag/status/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "ACTIVE"
}
{}
patch
Authorizations
Path parameters
tagIdstringRequired
Body
backupstringOptional
observabilitybooleanRequired
eventReplaybooleanRequired
Responses
200

Successful

application/json
object · Model28Optional
patch/tag/storage/{tagId}
PATCH /v1/tag/storage/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "backup": "text",
  "observability": true,
  "eventReplay": true
}
{}
PreviousStats
NextUser

Last updated

Was this helpful?