v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Cookies

Get List of Cookies by Criteria

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

🗒 Things to Know

  • If any of the available languages in the OneTrust application is entered as a value for the language parameter, cookie categories, descriptions, and third-party descriptions will be translated accordingly.
  • It is recommended to use the page and size parameters if the number of cookies is greater than 500.
post/v2/cookie-reports/search

Query parameters

languagestring

Name of the language.

countryCodestring

Country specific code.

searchStrstring

Search string includes either cookie name or host name.

pageinteger

Page number of the results list (0….N).

sizeinteger

Number of records per page (0…N).

Request body

domainsstring[]

Response

OK

Cookie details retrieved successfully.

numberOfElementsinteger

Total number of elements in the result list.

pageNumberinteger

Page number of the results list (0….N).

pageSizeinteger

Number of records per page (0…N).

totalElementsinteger

Total number of cookie results found.

totalPagesinteger

Total number of pages in the result.

Example response

{
  "sort": {
    "empty": true,
    "sorted": true
  }
}