Tag

get

Authorizations

Path parameters

tagIdstringRequired

Responses

200

Successful

application/json

tagIdstringRequired

teamIdstringRequired

namestringRequired

rootDomainstringRequired

domainstringRequired

createdAtstring · dateRequired

debugbooleanRequired

backupstringOptional

observabilitybooleanRequired

currencyConversionstringRequired

sameSitestringRequired

sdkVersionstringRequired

edgeVersionstringRequired

managedbooleanRequired

modestringRequired

platformstring · enumRequiredPossible values:

cookieMapKeystringRequired

statusstring · enumRequiredPossible values:

allowedEventsstringOptional

gpcbooleanRequired

deployedAtstring · dateRequired

deployIdstringOptional

idStorageMappingstringOptional

consentstring · enumRequiredPossible values:

d1UserScalenumberRequired

d1UserCountnumberRequired

currencyConversionTypestring · enumRequiredPossible values:

currencyProvidersstring[]Optional

eventReplaybooleanRequired

skipZeroPurchaseEventbooleanRequired

bindingsstringRequired

customCodestringRequired

strictOriginbooleanRequired

showDeleteRequestbooleanRequired

allowHyperscalerQuerybooleanRequired

tagTypestringRequired

configuratorSettingstring[]Required

labelsstring[]Optional

407

Proxy Authentication Required

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

get

/tag/{tagId}

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

{
  "tagId": "text",
  "teamId": "text",
  "name": "text",
  "rootDomain": "text",
  "domain": "text",
  "createdAt": "2026-03-06",
  "debug": true,
  "backup": "text",
  "observability": true,
  "currencyConversion": "text",
  "sameSite": "text",
  "sdkVersion": "text",
  "edgeVersion": "text",
  "managed": true,
  "mode": "text",
  "platform": "EDGETAG",
  "cookieMapKey": "text",
  "status": "ACTIVE",
  "allowedEvents": "text",
  "gpc": true,
  "dnsRecords": [
    {
      "value": "text",
      "name": "text",
      "type": "text",
      "TTL": 1,
      "note": "text"
    }
  ],
  "deployedAt": "2026-03-06",
  "deployId": "text",
  "scripts": [
    {
      "scriptId": "text",
      "name": "text",
      "createdAt": "2026-03-06",
      "providerId": "text",
      "consentCategory": "text",
      "secrets": {
        "string": {
          "secretId": "text",
          "value": "text",
          "type": "text",
          "isSet": true,
          "optional": true
        }
      },
      "geoRegions": "text"
    }
  ],
  "host": {
    "name": "text",
    "type": "text",
    "hostId": "text"
  },
  "idStorageMapping": "text",
  "consent": "DISABLED",
  "revenue": {
    "min": "text",
    "max": "text"
  },
  "d1UserScale": 1,
  "d1UserCount": 1,
  "currencyConversionType": "OFF",
  "customCurrencyConversions": [
    {
      "from": "text",
      "to": "text",
      "value": 1
    }
  ],
  "currencyProviders": [
    "text"
  ],
  "eventReplay": true,
  "skipZeroPurchaseEvent": true,
  "plugins": [
    {
      "pluginId": "text",
      "name": "text",
      "createdAt": "2026-03-06",
      "providerId": "text",
      "scripts": "text",
      "providers": "text",
      "secrets": {
        "string": {
          "secretId": "text",
          "value": "text",
          "type": "text",
          "isSet": true,
          "optional": true
        }
      }
    }
  ],
  "bindings": "text",
  "customCode": "text",
  "strictOrigin": true,
  "showDeleteRequest": true,
  "allowHyperscalerQuery": true,
  "tagType": "text",
  "configuratorSetting": [
    "text"
  ],
  "labels": [
    "text"
  ],
  "team": {
    "featureFlags": {}
  },
  "storageReferencedBy": [
    {
      "tagId": "text",
      "domain": "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

strictOriginbooleanOptional

Responses

200

Successful

application/json

objectOptional

400

Bad Request

application/json

403

Forbidden

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

put

/tag/{tagId}

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

{
  "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,
  "strictOrigin": true
}

{}

delete

Authorizations

Path parameters

tagIdstringRequired

Responses

200

Successful

application/json

objectOptional

400

Domain not found

application/json

406

Tag does not exist

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

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

403

Forbidden

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

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

objectOptional

403

Forbidden

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

get

/tag/d1-migrate/{tagId}

GET /v1/tag/d1-migrate/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{}

get

Authorizations

Path parameters

tagIdstringRequired

Responses

200

Successful

application/json

domainstringRequired

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

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

409

Tag does not exist

application/json

500

Internal Server Error

application/json

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-03-06",
    "recoveryTime": "2026-03-06"
  }
]

get

Authorizations

Path parameters

teamIdstringRequired

Responses

200

Successful

application/json

tagIdstringRequired

namestringRequired

domainstringRequired

debugbooleanRequired

sameSitestringRequired

sdkVersionstringRequired

edgeVersionstringRequired

managedbooleanRequired

deployedAtstring · dateRequired

409

Conflict

application/json

500

Internal Server Error

application/json

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-03-06",
    "scripts": [
      {
        "scriptId": "text",
        "name": "text",
        "providerId": "text"
      }
    ],
    "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

resultobjectOptional

409

Conflict

application/json

500

Internal Server Error

application/json

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

rangenumber · enumRequiredPossible values:

rangeTypestring · enumOptionalDefault: DAYPossible values:

Responses

200

Successful

application/json

resultobjectRequired

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/tag/analytics/first-touch-summary/{tagId}

GET /v1/tag/analytics/first-touch-summary/{tagId}?range=7 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {}
}

get

Authorizations

Path parameters

tagIdstringRequired

Query parameters

rangenumber · enumRequiredPossible values:

rangeTypestring · enumOptionalDefault: DAYPossible values:

Responses

200

Successful

application/json

resultobjectRequired

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/tag/analytics/first-touch-trends/{tagId}

GET /v1/tag/analytics/first-touch-trends/{tagId}?range=7 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {}
}

get

Authorizations

Path parameters

tagIdstringRequired

Query parameters

rangenumber · enumRequiredPossible values:

rangeTypestring · enumOptionalDefault: DAYPossible values:

Responses

200

Successful

application/json

resultobjectRequired

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/tag/analytics/metrics-overview/{tagId}

GET /v1/tag/analytics/metrics-overview/{tagId}?range=7 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {}
}

get

Authorizations

Path parameters

tagIdstringRequired

Query parameters

rangenumber · enumRequiredPossible values:

rangeTypestring · enumOptionalDefault: DAYPossible values:

Responses

200

Successful

application/json

resultobjectRequired

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/tag/analytics/non-consented-trends/{tagId}

GET /v1/tag/analytics/non-consented-trends/{tagId}?range=7 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

409

Conflict

application/json

500

Internal Server Error

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

resultobjectOptional

409

Conflict

application/json

500

Internal Server Error

application/json

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

Path parameters

tagIdstringRequired

Query parameters

rangenumber · enumRequiredPossible values:

rangeTypestring · enumOptionalDefault: DAYPossible values:

Responses

200

Successful

application/json

resultobjectRequired

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/tag/analytics/traffic-segments-trends/{tagId}

GET /v1/tag/analytics/traffic-segments-trends/{tagId}?range=7 HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "result": {}
}

get

Authorizations

Path parameters

tagIdstringRequired

Responses

200

Successful

application/json

messagestringOptional

validbooleanOptional

409

Conflict

application/json

500

Internal Server Error

application/json

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

400

Bad Request

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

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

objectOptional

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

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

pluginsOrderstring[]Optional

Responses

200

Successful

application/json

objectOptional

407

Proxy Authentication Required

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

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

Path parameters

tagIdstringRequired

Body

querystringRequired

databasesstring[]Optional

Responses

200

Successful

application/json

objectOptional

403

Forbidden

application/json

500

Internal Server Error

application/json

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: 37

{
  "query": "text",
  "databases": [
    "text"
  ]
}

{}

put

Authorizations

Path parameters

tagIdstringRequired

Body

d1UserScalenumberOptional

d1UserCountnumberOptional

Responses

200

Successful

application/json

objectOptional

400

Bad Request

application/json

403

Forbidden

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

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

Path parameters

tagIdstringRequired

Body

showDeleteRequestbooleanOptional

allowHyperscalerQuerybooleanOptional

Responses

200

Successful

application/json

objectOptional

400

Bad Request

application/json

403

Forbidden

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

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
}

{}

Authorizations

Path parameters

tagIdstringRequired

Body

emailsstring[] · min: 1Required

Responses

200

Successful

application/json

messagestringOptional

400

Bad Request

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

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

Path parameters

tagIdstringRequired

Body

configuratorSettingstring[]Required

Responses

200

Successful

application/json

objectOptional

400

Bad Request

application/json

403

Forbidden

application/json

409

Tag does not exist

application/json

500

Internal Server Error

application/json

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: 32

{
  "configuratorSetting": [
    "text"
  ]
}

{}

patch

Authorizations

Path parameters

tagIdstringRequired

Body

bindingsstringOptional

Responses

200

Successful

application/json

objectOptional

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

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

objectOptional

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

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

Path parameters

tagIdstringRequired

Body

statusstring · enumRequiredPossible values:

Responses

200

Successful

application/json

objectOptional

403

Forbidden

application/json

500

Internal Server Error

application/json

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

objectOptional

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

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 17 hours ago

Was this helpful?