myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Get List of Cookies by Criteria

post
https://{hostname}/api/cmp/v1/webscans/languages//cookies/filter

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

Path Params
string
required
length between 2 and 5

The language code for localized content.

Query Params
string
length between 2 and 2

The country code for regional settings.

string
length ≤ 255

The name of the cookie.

string
enum

Field to sort by

Allowed:
string
enum

Sort direction

Allowed:
integer
≥ 0
Defaults to 0

The page number for pagination results, starting from 0.

integer
1 to 2000
Defaults to 10

The number of items to return per page.

Body Params
status
array of strings

The current state or condition of the item.

status
source
array of strings

The source from which the data or cookie originated.

source
lifespan
array of strings

The duration for which the cookie remains active before expiring.

lifespan
categories
array of uuids

The cookie categories assigned to the item.

categories
domainCategoryOverrides
array of uuids

The custom category assignments that override the default settings.

domainCategoryOverrides
domains
array of uuids

The list of website domains.

domains
Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response 
 Choose an example:
application/json
*/*
Updated 4 months ago