v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Get List of Cookies by Criteria

Use this API to retrieve a list of cookies by the specified filter criteria.

post/api/cmp/v1/webscans/languages/{language}/cookies/filter

Path parameters

languagestring required

The language code for localized content.

Query parameters

countryCodestring

The country code for regional settings.

cookieNamestring

The name of the cookie.

sortBy'cookieName' | 'host' | 'category'

Field to sort by

direction'asc' | 'desc'

Sort direction

pageinteger

Example:1

The page number for pagination results, starting from 0.

sizeinteger

Example:10

The number of items to return per page.

Request body

statusstring[]

The current state or condition of the item.

sourcestring[]

The source from which the data or cookie originated.

lifespanstring[]

The duration for which the cookie remains active before expiring.

categoriesstring[]

The cookie categories assigned to the item.

domainCategoryOverridesstring[]

The custom category assignments that override the default settings.

domainsstring[]

The list of website domains.

Response

totalPagesinteger

The total number of pages in the paginated results.

totalElementsinteger

The total number of items in the complete result set.

sizeinteger

The number of items to return per page.

numberinteger

The numeric value or identifier.

firstboolean

This flag indicates whether this is the first item in a sequence.

lastboolean

This flag indicates whether this is the last item in a sequence.

numberOfElementsinteger

The number of items in the current page.

emptyboolean

This flag indicates whether the result set is empty.

Example response

{
  "content": [
    {
      "cookieId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "cookieName": "cookie123",
      "description": "This cookies is used for functional purposes",
      "lifespan": "PERSISTENT",
      "host": "amazon.com",
      "displayGroupId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "displayGroupName": "displayGroup1",
      "cookieSource": "MANUAL",
      "domainCookieCategoryList": [
        {
          "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "displayGroupId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "description": "used for advertising"
        }
      ],
      "length": 5,
      "durationType": "MONTH",
      "licenseType": 50,
      "isCustomDesc": true,
      "thirdParty": true,
      "thirdPartyDescription": "This cookie is used for third-party advertising",
      "isThirdPartyCustomDesc": true
    }
  ]
}