OSosano
cmpRules

List Rules Across All Configurations

Changed on

Returns Cookie Consent Rules from all of the authenticated customer's Cookie Consent Configurations, without requiring a configuration ID, most recently created first. Each rule includes the configId it belongs to. Filters can be combined. Results are paginated with up to 500 items per page; pass the next token from the response to get the following page, until a page comes back empty (the token carries the original filters, so other query parameters are ignored when next is set).

get/v1/cookie-consent/rules

Request

Query parameters

configIdstring uuid

Return only results from this Cookie Consent Configuration. Must be one of the customer's configurations, otherwise a 404 is returned.

rulestring

Return only rules whose rule exactly matches this value. Partial values do not match.

type'cookie' | 'script' | 'iframe' | 'localStorage'

The type of Rule to be returned. If omitted, all rule types are returned.

ruleType'FILENAME' | 'DOMAIN' | 'PATH' | 'REGEXP' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'EXACT_MATCH'

Return only rules with this rule (match) type.

classification'ESSENTIAL' | 'ANALYTICS' | 'MARKETING' | 'PERSONALIZATION' | 'HIDDEN' | 'BLACKLISTED'

The type of rule classification to be returned.

limitinteger

The number of items to return.

nextstring

The pagination token from the previous request.

Response

Success

nextstring

Pagination token for the next page. Omitted when the page is empty.

Changes