Get Categorized Cookies

Use this API to retrieve categorized cookies by domain.

post/api/cmp/v1/cookies/categorized

Request

Base URL
https://hostname
URL
https://hostname/api/cmp/v1/cookies/categorized
Auth
OAuth 2
Client credentials
Token URL: https://{hostname}/api/access/v1/oauth/token scopes: COOKIE, COOKIE_READ

Request body

domainstring

The website domain being managed.

cookieIdsstring[]

The list of cookie identifiers.

Example request

{
  "domain": "amazon.com",
  "cookieIds": [
    "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "cookies": [
    {
      "cookieName": "session_id",
      "host": "example.com"
    },
    {
      "cookieName": "user_token",
      "host": "test.com"
    }
  ]
}

Response

namestring

The name of the item.

typestring

The type or category classification of the item.

hoststring

The domain or website that created the cookie.

hostDescriptionstring

The description of the host domain.

descriptionstring

The description of the item and its intended purpose.

firstPartyDescriptionstring

The description of first-party cookies and their usage.

thirdPartyDescriptionstring

The description of third-party cookies and their usage.

patternKeystring

The pattern key used for cookie identification and matching.

thirdPartyKeystring

The key identifier used for third-party cookie classification.

firstPartyKeystring

The key identifier used for first-party cookie classification.

categorystring

The category assigned to the cookie for classification purposes.

domainCountinteger

No of domains where this cookie is active.

Example response

[
  {
    "name": "cookie123",
    "type": "First Party",
    "host": "amazon.com",
    "hostDescription": "amazon.com is a website",
    "description": "This cookie is used for advertising purposes.",
    "firstPartyDescription": "This cookie is used for advertising purposes.",
    "thirdPartyDescription": "This cookie is used for advertising purposes.",
    "patternKey": "C1_",
    "thirdPartyKey": "Cookie|cookie123",
    "firstPartyKey": "Cookie|cookie123|amazon.com",
    "category": "Functionality"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.