CDPGuidesSupport

Consent Settings

Consent settings endpoints manage CMP rules, regional overrides, and vendor categorization; analytics endpoints return time-series, per-page, and per-region rollups of banner views, opt-ins, opt-outs, and dismissals.

The CRUD endpoints manage consent rules, regional overrides, and vendor categorization. The analytics endpoints expose per-record time-series, per-page, and per-region rollups of banner views, opt-ins, opt-outs, and dismissals.

AI assistants can manage consent settings and read the same analytics through the MCP server.

Analytics filters

The analytics, analytics-monthly, page-analysis, and analytics-by-region endpoints accept the same optional filter query parameter. Its value is a URL-encoded JSON analytics filter definition. A host predicate, for example, narrows the report to one domain:

curl --get 'https://app.oursprivacy.com/rest/v1/consent-settings/YOUR_CONSENT_SETTING_ID/analytics' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-urlencode 'from=2026-09-01' \
  --data-urlencode 'to=2026-09-30' \
  --data-urlencode 'filter={"version":1,"filter":{"kind":"predicate","property":"event.default_properties.host","operator":"eq","value":"www.example.com"}}'

The shared definition supports event, source, session, and custom-property conditions, including nested and and or groups. Geography conditions use the same definition.

Per-setting reporting periods

Series rows include periodFrom, periodTo, and partialPeriod, which flags buckets that only partly overlap the requested range. Visitor counts are unique within each bucket, and totals counts unique visitors across the whole window, so summing the buckets does not reproduce the total.

GET /rest/v1/consent-settings/analytics-capabilities returns the reporting intervals and comparisons your organization supports. Page Analysis is cursor-paginated: pass pagination.nextCursor as cursor with the same dates, interval, filter, and search.

GET
/rest/v1/consent-settings
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings"
{  "entities": [    {      "id": "string",      "name": "string",      "kind": "string",      "status": "Disabled",      "createdAt": "string",      "updatedAt": "string",      "whitelistDomains": [        "string"      ],      "consentCookieName": "string",      "deviceIdCookieName": "string",      "webSDKToken": "string",      "customDomain": "string",      "revision": 0,      "skipBlockingClassNames": [        "string"      ],      "services": [        {          "additionalCategories": [            "string"          ],          "category": "string",          "domainPatterns": [            "string"          ],          "internalNotes": "string",          "label": "string"        }      ],      "categories": [        {          "label": "string",          "priority": 0,          "value": "string"        }      ],      "default": {        "autoShow": true,        "autoShowDismissConfig": {          "pageCount": 0,          "seconds": 0        },        "autoShowDismissMode": "after_pages",        "autoblockUnknown": true,        "categories": [          {            "key": "string",            "value": {              "autoDisableOnGPC": true,              "enabled": true,              "readOnly": true,              "reloadPage": true            }          }        ],        "disablePageInteraction": true,        "guiOptions": {          "consentModal": {            "buttonLayout": "AcceptAllNecessaryPreferences",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "bottom",            "showCloseIcon": true          },          "cssVariables": {            "buttonBorderRadius": "string",            "footerBg": "string",            "footerColor": "string",            "footerLinkColor": "string",            "footerLinkHoverColor": "string",            "modalBg": "string",            "modalBorderRadius": "string",            "primaryButtonBg": "string",            "primaryButtonColor": "string",            "primaryButtonHoverBg": "string",            "primaryButtonHoverColor": "string",            "primaryTextColor": "string",            "secondaryButtonBg": "string",            "secondaryButtonColor": "string",            "secondaryButtonHoverBg": "string",            "secondaryButtonHoverColor": "string",            "secondaryTextColor": "string",            "toggleOnBg": "string",            "cookieCategoryBlockBg": "string",            "cookieCategoryBlockHoverBg": "string"          },          "preferencesModal": {            "buttonLayout": "AcceptAllRejectAllSave",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "left"          }        },        "hideFromBots": true,        "language": "en",        "mode": "opt_in",        "showVendorsInPreferences": true,        "translations": [          {            "language": "en",            "value": {              "consentModal": {                "acceptAllBtn": "string",                "closeIconLabel": "string",                "description": "string",                "footer": "string",                "gpcNotification": "string",                "privacyPolicyLabel": "string",                "privacyPolicyUrl": "string",                "rejectAllBtn": "string",                "revisionMessage": "string",                "showPreferencesBtn": "string",                "termsOfServiceLabel": "string",                "termsOfServiceUrl": "string",                "title": "string"              },              "preferencesModal": {                "acceptAllBtn": "string",                "additionalInfo": {                  "body": "string",                  "title": "string"                },                "closeIconLabel": "string",                "rejectAllBtn": "string",                "savePreferencesBtn": "string",                "sections": [                  {                    "cookieTable": {                      "body": [                        {                          "key": "string",                          "value": "string"                        }                      ],                      "caption": "string",                      "headers": [                        {                          "key": "string",                          "value": "string"                        }                      ]                    },                    "description": "string",                    "linkedCategory": "string",                    "title": "string"                  }                ],                "serviceCounterLabel": "string",                "title": "string"              }            }          }        ]      },      "regions": [        {          "additionalRegions": [            "string"          ],          "name": "string",          "regionCode": "US-CA",          "rule": {            "autoShow": true,            "autoShowDismissConfig": {              "pageCount": 0,              "seconds": 0            },            "autoShowDismissMode": "after_pages",            "autoblockUnknown": true,            "categories": [              {                "key": "string",                "value": {                  "autoDisableOnGPC": true,                  "enabled": true,                  "readOnly": true,                  "reloadPage": true                }              }            ],            "disablePageInteraction": true,            "guiOptions": {              "consentModal": {                "buttonLayout": "AcceptAllNecessaryPreferences",                "equalWeightButtons": true,                "flipButtons": true,                "layout": "bar",                "position": "bottom",                "showCloseIcon": true              },              "cssVariables": {                "buttonBorderRadius": "string",                "footerBg": "string",                "footerColor": "string",                "footerLinkColor": "string",                "footerLinkHoverColor": "string",                "modalBg": "string",                "modalBorderRadius": "string",                "primaryButtonBg": "string",                "primaryButtonColor": "string",                "primaryButtonHoverBg": "string",                "primaryButtonHoverColor": "string",                "primaryTextColor": "string",                "secondaryButtonBg": "string",                "secondaryButtonColor": "string",                "secondaryButtonHoverBg": "string",                "secondaryButtonHoverColor": "string",                "secondaryTextColor": "string",                "toggleOnBg": "string",                "cookieCategoryBlockBg": "string",                "cookieCategoryBlockHoverBg": "string"              },              "preferencesModal": {                "buttonLayout": "AcceptAllRejectAllSave",                "equalWeightButtons": true,                "flipButtons": true,                "layout": "bar",                "position": "left"              }            },            "hideFromBots": true,            "language": "en",            "mode": "opt_in",            "showVendorsInPreferences": true,            "translations": [              {                "language": "en",                "value": {                  "consentModal": {                    "acceptAllBtn": "string",                    "closeIconLabel": "string",                    "description": "string",                    "footer": "string",                    "gpcNotification": "string",                    "privacyPolicyLabel": "string",                    "privacyPolicyUrl": "string",                    "rejectAllBtn": "string",                    "revisionMessage": "string",                    "showPreferencesBtn": "string",                    "termsOfServiceLabel": "string",                    "termsOfServiceUrl": "string",                    "title": "string"                  },                  "preferencesModal": {                    "acceptAllBtn": "string",                    "additionalInfo": {                      "body": "string",                      "title": "string"                    },                    "closeIconLabel": "string",                    "rejectAllBtn": "string",                    "savePreferencesBtn": "string",                    "sections": [                      {                        "cookieTable": {                          "body": [                            {}                          ],                          "caption": "string",                          "headers": [                            {}                          ]                        },                        "description": "string",                        "linkedCategory": "string",                        "title": "string"                      }                    ],                    "serviceCounterLabel": "string",                    "title": "string"                  }                }              }            ]          }        }      ]    }  ]}

POST/rest/v1/consent-settings

POST
/rest/v1/consent-settings
AuthorizationBearer <token>

Ours Privacy API key

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/rest/v1/consent-settings"
{  "id": "string",  "name": "string",  "kind": "string",  "status": "Disabled",  "createdAt": "string",  "updatedAt": "string",  "whitelistDomains": [    "string"  ],  "consentCookieName": "string",  "deviceIdCookieName": "string",  "webSDKToken": "string",  "customDomain": "string",  "revision": 0,  "skipBlockingClassNames": [    "string"  ],  "services": [    {      "additionalCategories": [        "string"      ],      "category": "string",      "domainPatterns": [        "string"      ],      "internalNotes": "string",      "label": "string"    }  ],  "categories": [    {      "label": "string",      "priority": 0,      "value": "string"    }  ],  "default": {    "autoShow": true,    "autoShowDismissConfig": {      "pageCount": 0,      "seconds": 0    },    "autoShowDismissMode": "after_pages",    "autoblockUnknown": true,    "categories": [      {        "key": "string",        "value": {          "autoDisableOnGPC": true,          "enabled": true,          "readOnly": true,          "reloadPage": true        }      }    ],    "disablePageInteraction": true,    "guiOptions": {      "consentModal": {        "buttonLayout": "AcceptAllNecessaryPreferences",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "bottom",        "showCloseIcon": true      },      "cssVariables": {        "buttonBorderRadius": "string",        "footerBg": "string",        "footerColor": "string",        "footerLinkColor": "string",        "footerLinkHoverColor": "string",        "modalBg": "string",        "modalBorderRadius": "string",        "primaryButtonBg": "string",        "primaryButtonColor": "string",        "primaryButtonHoverBg": "string",        "primaryButtonHoverColor": "string",        "primaryTextColor": "string",        "secondaryButtonBg": "string",        "secondaryButtonColor": "string",        "secondaryButtonHoverBg": "string",        "secondaryButtonHoverColor": "string",        "secondaryTextColor": "string",        "toggleOnBg": "string",        "cookieCategoryBlockBg": "string",        "cookieCategoryBlockHoverBg": "string"      },      "preferencesModal": {        "buttonLayout": "AcceptAllRejectAllSave",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "left"      }    },    "hideFromBots": true,    "language": "en",    "mode": "opt_in",    "showVendorsInPreferences": true,    "translations": [      {        "language": "en",        "value": {          "consentModal": {            "acceptAllBtn": "string",            "closeIconLabel": "string",            "description": "string",            "footer": "string",            "gpcNotification": "string",            "privacyPolicyLabel": "string",            "privacyPolicyUrl": "string",            "rejectAllBtn": "string",            "revisionMessage": "string",            "showPreferencesBtn": "string",            "termsOfServiceLabel": "string",            "termsOfServiceUrl": "string",            "title": "string"          },          "preferencesModal": {            "acceptAllBtn": "string",            "additionalInfo": {              "body": "string",              "title": "string"            },            "closeIconLabel": "string",            "rejectAllBtn": "string",            "savePreferencesBtn": "string",            "sections": [              {                "cookieTable": {                  "body": [                    {                      "key": "string",                      "value": "string"                    }                  ],                  "caption": "string",                  "headers": [                    {                      "key": "string",                      "value": "string"                    }                  ]                },                "description": "string",                "linkedCategory": "string",                "title": "string"              }            ],            "serviceCounterLabel": "string",            "title": "string"          }        }      }    ]  },  "regions": [    {      "additionalRegions": [        "string"      ],      "name": "string",      "regionCode": "US-CA",      "rule": {        "autoShow": true,        "autoShowDismissConfig": {          "pageCount": 0,          "seconds": 0        },        "autoShowDismissMode": "after_pages",        "autoblockUnknown": true,        "categories": [          {            "key": "string",            "value": {              "autoDisableOnGPC": true,              "enabled": true,              "readOnly": true,              "reloadPage": true            }          }        ],        "disablePageInteraction": true,        "guiOptions": {          "consentModal": {            "buttonLayout": "AcceptAllNecessaryPreferences",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "bottom",            "showCloseIcon": true          },          "cssVariables": {            "buttonBorderRadius": "string",            "footerBg": "string",            "footerColor": "string",            "footerLinkColor": "string",            "footerLinkHoverColor": "string",            "modalBg": "string",            "modalBorderRadius": "string",            "primaryButtonBg": "string",            "primaryButtonColor": "string",            "primaryButtonHoverBg": "string",            "primaryButtonHoverColor": "string",            "primaryTextColor": "string",            "secondaryButtonBg": "string",            "secondaryButtonColor": "string",            "secondaryButtonHoverBg": "string",            "secondaryButtonHoverColor": "string",            "secondaryTextColor": "string",            "toggleOnBg": "string",            "cookieCategoryBlockBg": "string",            "cookieCategoryBlockHoverBg": "string"          },          "preferencesModal": {            "buttonLayout": "AcceptAllRejectAllSave",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "left"          }        },        "hideFromBots": true,        "language": "en",        "mode": "opt_in",        "showVendorsInPreferences": true,        "translations": [          {            "language": "en",            "value": {              "consentModal": {                "acceptAllBtn": "string",                "closeIconLabel": "string",                "description": "string",                "footer": "string",                "gpcNotification": "string",                "privacyPolicyLabel": "string",                "privacyPolicyUrl": "string",                "rejectAllBtn": "string",                "revisionMessage": "string",                "showPreferencesBtn": "string",                "termsOfServiceLabel": "string",                "termsOfServiceUrl": "string",                "title": "string"              },              "preferencesModal": {                "acceptAllBtn": "string",                "additionalInfo": {                  "body": "string",                  "title": "string"                },                "closeIconLabel": "string",                "rejectAllBtn": "string",                "savePreferencesBtn": "string",                "sections": [                  {                    "cookieTable": {                      "body": [                        {                          "key": "string",                          "value": "string"                        }                      ],                      "caption": "string",                      "headers": [                        {                          "key": "string",                          "value": "string"                        }                      ]                    },                    "description": "string",                    "linkedCategory": "string",                    "title": "string"                  }                ],                "serviceCounterLabel": "string",                "title": "string"              }            }          }        ]      }    }  ]}
GET
/rest/v1/consent-settings/{id}
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/string"
{  "id": "string",  "name": "string",  "kind": "string",  "status": "Disabled",  "createdAt": "string",  "updatedAt": "string",  "whitelistDomains": [    "string"  ],  "consentCookieName": "string",  "deviceIdCookieName": "string",  "webSDKToken": "string",  "customDomain": "string",  "revision": 0,  "skipBlockingClassNames": [    "string"  ],  "services": [    {      "additionalCategories": [        "string"      ],      "category": "string",      "domainPatterns": [        "string"      ],      "internalNotes": "string",      "label": "string"    }  ],  "categories": [    {      "label": "string",      "priority": 0,      "value": "string"    }  ],  "default": {    "autoShow": true,    "autoShowDismissConfig": {      "pageCount": 0,      "seconds": 0    },    "autoShowDismissMode": "after_pages",    "autoblockUnknown": true,    "categories": [      {        "key": "string",        "value": {          "autoDisableOnGPC": true,          "enabled": true,          "readOnly": true,          "reloadPage": true        }      }    ],    "disablePageInteraction": true,    "guiOptions": {      "consentModal": {        "buttonLayout": "AcceptAllNecessaryPreferences",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "bottom",        "showCloseIcon": true      },      "cssVariables": {        "buttonBorderRadius": "string",        "footerBg": "string",        "footerColor": "string",        "footerLinkColor": "string",        "footerLinkHoverColor": "string",        "modalBg": "string",        "modalBorderRadius": "string",        "primaryButtonBg": "string",        "primaryButtonColor": "string",        "primaryButtonHoverBg": "string",        "primaryButtonHoverColor": "string",        "primaryTextColor": "string",        "secondaryButtonBg": "string",        "secondaryButtonColor": "string",        "secondaryButtonHoverBg": "string",        "secondaryButtonHoverColor": "string",        "secondaryTextColor": "string",        "toggleOnBg": "string",        "cookieCategoryBlockBg": "string",        "cookieCategoryBlockHoverBg": "string"      },      "preferencesModal": {        "buttonLayout": "AcceptAllRejectAllSave",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "left"      }    },    "hideFromBots": true,    "language": "en",    "mode": "opt_in",    "showVendorsInPreferences": true,    "translations": [      {        "language": "en",        "value": {          "consentModal": {            "acceptAllBtn": "string",            "closeIconLabel": "string",            "description": "string",            "footer": "string",            "gpcNotification": "string",            "privacyPolicyLabel": "string",            "privacyPolicyUrl": "string",            "rejectAllBtn": "string",            "revisionMessage": "string",            "showPreferencesBtn": "string",            "termsOfServiceLabel": "string",            "termsOfServiceUrl": "string",            "title": "string"          },          "preferencesModal": {            "acceptAllBtn": "string",            "additionalInfo": {              "body": "string",              "title": "string"            },            "closeIconLabel": "string",            "rejectAllBtn": "string",            "savePreferencesBtn": "string",            "sections": [              {                "cookieTable": {                  "body": [                    {                      "key": "string",                      "value": "string"                    }                  ],                  "caption": "string",                  "headers": [                    {                      "key": "string",                      "value": "string"                    }                  ]                },                "description": "string",                "linkedCategory": "string",                "title": "string"              }            ],            "serviceCounterLabel": "string",            "title": "string"          }        }      }    ]  },  "regions": [    {      "additionalRegions": [        "string"      ],      "name": "string",      "regionCode": "US-CA",      "rule": {        "autoShow": true,        "autoShowDismissConfig": {          "pageCount": 0,          "seconds": 0        },        "autoShowDismissMode": "after_pages",        "autoblockUnknown": true,        "categories": [          {            "key": "string",            "value": {              "autoDisableOnGPC": true,              "enabled": true,              "readOnly": true,              "reloadPage": true            }          }        ],        "disablePageInteraction": true,        "guiOptions": {          "consentModal": {            "buttonLayout": "AcceptAllNecessaryPreferences",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "bottom",            "showCloseIcon": true          },          "cssVariables": {            "buttonBorderRadius": "string",            "footerBg": "string",            "footerColor": "string",            "footerLinkColor": "string",            "footerLinkHoverColor": "string",            "modalBg": "string",            "modalBorderRadius": "string",            "primaryButtonBg": "string",            "primaryButtonColor": "string",            "primaryButtonHoverBg": "string",            "primaryButtonHoverColor": "string",            "primaryTextColor": "string",            "secondaryButtonBg": "string",            "secondaryButtonColor": "string",            "secondaryButtonHoverBg": "string",            "secondaryButtonHoverColor": "string",            "secondaryTextColor": "string",            "toggleOnBg": "string",            "cookieCategoryBlockBg": "string",            "cookieCategoryBlockHoverBg": "string"          },          "preferencesModal": {            "buttonLayout": "AcceptAllRejectAllSave",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "left"          }        },        "hideFromBots": true,        "language": "en",        "mode": "opt_in",        "showVendorsInPreferences": true,        "translations": [          {            "language": "en",            "value": {              "consentModal": {                "acceptAllBtn": "string",                "closeIconLabel": "string",                "description": "string",                "footer": "string",                "gpcNotification": "string",                "privacyPolicyLabel": "string",                "privacyPolicyUrl": "string",                "rejectAllBtn": "string",                "revisionMessage": "string",                "showPreferencesBtn": "string",                "termsOfServiceLabel": "string",                "termsOfServiceUrl": "string",                "title": "string"              },              "preferencesModal": {                "acceptAllBtn": "string",                "additionalInfo": {                  "body": "string",                  "title": "string"                },                "closeIconLabel": "string",                "rejectAllBtn": "string",                "savePreferencesBtn": "string",                "sections": [                  {                    "cookieTable": {                      "body": [                        {                          "key": "string",                          "value": "string"                        }                      ],                      "caption": "string",                      "headers": [                        {                          "key": "string",                          "value": "string"                        }                      ]                    },                    "description": "string",                    "linkedCategory": "string",                    "title": "string"                  }                ],                "serviceCounterLabel": "string",                "title": "string"              }            }          }        ]      }    }  ]}
PATCH
/rest/v1/consent-settings/{id}
*object
array<object>
array<object>
object
array<object>
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/rest/v1/consent-settings/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "kind": "string",  "status": "Disabled",  "createdAt": "string",  "updatedAt": "string",  "whitelistDomains": [    "string"  ],  "consentCookieName": "string",  "deviceIdCookieName": "string",  "webSDKToken": "string",  "customDomain": "string",  "revision": 0,  "skipBlockingClassNames": [    "string"  ],  "services": [    {      "additionalCategories": [        "string"      ],      "category": "string",      "domainPatterns": [        "string"      ],      "internalNotes": "string",      "label": "string"    }  ],  "categories": [    {      "label": "string",      "priority": 0,      "value": "string"    }  ],  "default": {    "autoShow": true,    "autoShowDismissConfig": {      "pageCount": 0,      "seconds": 0    },    "autoShowDismissMode": "after_pages",    "autoblockUnknown": true,    "categories": [      {        "key": "string",        "value": {          "autoDisableOnGPC": true,          "enabled": true,          "readOnly": true,          "reloadPage": true        }      }    ],    "disablePageInteraction": true,    "guiOptions": {      "consentModal": {        "buttonLayout": "AcceptAllNecessaryPreferences",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "bottom",        "showCloseIcon": true      },      "cssVariables": {        "buttonBorderRadius": "string",        "footerBg": "string",        "footerColor": "string",        "footerLinkColor": "string",        "footerLinkHoverColor": "string",        "modalBg": "string",        "modalBorderRadius": "string",        "primaryButtonBg": "string",        "primaryButtonColor": "string",        "primaryButtonHoverBg": "string",        "primaryButtonHoverColor": "string",        "primaryTextColor": "string",        "secondaryButtonBg": "string",        "secondaryButtonColor": "string",        "secondaryButtonHoverBg": "string",        "secondaryButtonHoverColor": "string",        "secondaryTextColor": "string",        "toggleOnBg": "string",        "cookieCategoryBlockBg": "string",        "cookieCategoryBlockHoverBg": "string"      },      "preferencesModal": {        "buttonLayout": "AcceptAllRejectAllSave",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "left"      }    },    "hideFromBots": true,    "language": "en",    "mode": "opt_in",    "showVendorsInPreferences": true,    "translations": [      {        "language": "en",        "value": {          "consentModal": {            "acceptAllBtn": "string",            "closeIconLabel": "string",            "description": "string",            "footer": "string",            "gpcNotification": "string",            "privacyPolicyLabel": "string",            "privacyPolicyUrl": "string",            "rejectAllBtn": "string",            "revisionMessage": "string",            "showPreferencesBtn": "string",            "termsOfServiceLabel": "string",            "termsOfServiceUrl": "string",            "title": "string"          },          "preferencesModal": {            "acceptAllBtn": "string",            "additionalInfo": {              "body": "string",              "title": "string"            },            "closeIconLabel": "string",            "rejectAllBtn": "string",            "savePreferencesBtn": "string",            "sections": [              {                "cookieTable": {                  "body": [                    {                      "key": "string",                      "value": "string"                    }                  ],                  "caption": "string",                  "headers": [                    {                      "key": "string",                      "value": "string"                    }                  ]                },                "description": "string",                "linkedCategory": "string",                "title": "string"              }            ],            "serviceCounterLabel": "string",            "title": "string"          }        }      }    ]  },  "regions": [    {      "additionalRegions": [        "string"      ],      "name": "string",      "regionCode": "US-CA",      "rule": {        "autoShow": true,        "autoShowDismissConfig": {          "pageCount": 0,          "seconds": 0        },        "autoShowDismissMode": "after_pages",        "autoblockUnknown": true,        "categories": [          {            "key": "string",            "value": {              "autoDisableOnGPC": true,              "enabled": true,              "readOnly": true,              "reloadPage": true            }          }        ],        "disablePageInteraction": true,        "guiOptions": {          "consentModal": {            "buttonLayout": "AcceptAllNecessaryPreferences",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "bottom",            "showCloseIcon": true          },          "cssVariables": {            "buttonBorderRadius": "string",            "footerBg": "string",            "footerColor": "string",            "footerLinkColor": "string",            "footerLinkHoverColor": "string",            "modalBg": "string",            "modalBorderRadius": "string",            "primaryButtonBg": "string",            "primaryButtonColor": "string",            "primaryButtonHoverBg": "string",            "primaryButtonHoverColor": "string",            "primaryTextColor": "string",            "secondaryButtonBg": "string",            "secondaryButtonColor": "string",            "secondaryButtonHoverBg": "string",            "secondaryButtonHoverColor": "string",            "secondaryTextColor": "string",            "toggleOnBg": "string",            "cookieCategoryBlockBg": "string",            "cookieCategoryBlockHoverBg": "string"          },          "preferencesModal": {            "buttonLayout": "AcceptAllRejectAllSave",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "left"          }        },        "hideFromBots": true,        "language": "en",        "mode": "opt_in",        "showVendorsInPreferences": true,        "translations": [          {            "language": "en",            "value": {              "consentModal": {                "acceptAllBtn": "string",                "closeIconLabel": "string",                "description": "string",                "footer": "string",                "gpcNotification": "string",                "privacyPolicyLabel": "string",                "privacyPolicyUrl": "string",                "rejectAllBtn": "string",                "revisionMessage": "string",                "showPreferencesBtn": "string",                "termsOfServiceLabel": "string",                "termsOfServiceUrl": "string",                "title": "string"              },              "preferencesModal": {                "acceptAllBtn": "string",                "additionalInfo": {                  "body": "string",                  "title": "string"                },                "closeIconLabel": "string",                "rejectAllBtn": "string",                "savePreferencesBtn": "string",                "sections": [                  {                    "cookieTable": {                      "body": [                        {                          "key": "string",                          "value": "string"                        }                      ],                      "caption": "string",                      "headers": [                        {                          "key": "string",                          "value": "string"                        }                      ]                    },                    "description": "string",                    "linkedCategory": "string",                    "title": "string"                  }                ],                "serviceCounterLabel": "string",                "title": "string"              }            }          }        ]      }    }  ]}
PUT
/rest/v1/consent-settings/{id}
*object
array<object>
object
array<object>
array<object>
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/rest/v1/consent-settings/string" \  -H "Content-Type: application/json" \  -d '{    "categories": [      {        "label": "string",        "priority": 0,        "value": "string"      }    ],    "default": {      "categories": [        {          "key": "string",          "value": {            "enabled": true          }        }      ],      "language": "en",      "mode": "opt_in",      "translations": [        {          "language": "en",          "value": {}        }      ]    },    "name": "string",    "regions": [      {        "regionCode": "US-CA",        "rule": {          "categories": [            {              "key": "string",              "value": {                "enabled": true              }            }          ],          "language": "en",          "mode": "opt_in",          "translations": [            {              "language": "en",              "value": {}            }          ]        }      }    ],    "services": [      {        "internalNotes": "string",        "label": "string"      }    ],    "status": "Disabled"  }'
{  "id": "string",  "name": "string",  "kind": "string",  "status": "Disabled",  "createdAt": "string",  "updatedAt": "string",  "whitelistDomains": [    "string"  ],  "consentCookieName": "string",  "deviceIdCookieName": "string",  "webSDKToken": "string",  "customDomain": "string",  "revision": 0,  "skipBlockingClassNames": [    "string"  ],  "services": [    {      "additionalCategories": [        "string"      ],      "category": "string",      "domainPatterns": [        "string"      ],      "internalNotes": "string",      "label": "string"    }  ],  "categories": [    {      "label": "string",      "priority": 0,      "value": "string"    }  ],  "default": {    "autoShow": true,    "autoShowDismissConfig": {      "pageCount": 0,      "seconds": 0    },    "autoShowDismissMode": "after_pages",    "autoblockUnknown": true,    "categories": [      {        "key": "string",        "value": {          "autoDisableOnGPC": true,          "enabled": true,          "readOnly": true,          "reloadPage": true        }      }    ],    "disablePageInteraction": true,    "guiOptions": {      "consentModal": {        "buttonLayout": "AcceptAllNecessaryPreferences",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "bottom",        "showCloseIcon": true      },      "cssVariables": {        "buttonBorderRadius": "string",        "footerBg": "string",        "footerColor": "string",        "footerLinkColor": "string",        "footerLinkHoverColor": "string",        "modalBg": "string",        "modalBorderRadius": "string",        "primaryButtonBg": "string",        "primaryButtonColor": "string",        "primaryButtonHoverBg": "string",        "primaryButtonHoverColor": "string",        "primaryTextColor": "string",        "secondaryButtonBg": "string",        "secondaryButtonColor": "string",        "secondaryButtonHoverBg": "string",        "secondaryButtonHoverColor": "string",        "secondaryTextColor": "string",        "toggleOnBg": "string",        "cookieCategoryBlockBg": "string",        "cookieCategoryBlockHoverBg": "string"      },      "preferencesModal": {        "buttonLayout": "AcceptAllRejectAllSave",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "left"      }    },    "hideFromBots": true,    "language": "en",    "mode": "opt_in",    "showVendorsInPreferences": true,    "translations": [      {        "language": "en",        "value": {          "consentModal": {            "acceptAllBtn": "string",            "closeIconLabel": "string",            "description": "string",            "footer": "string",            "gpcNotification": "string",            "privacyPolicyLabel": "string",            "privacyPolicyUrl": "string",            "rejectAllBtn": "string",            "revisionMessage": "string",            "showPreferencesBtn": "string",            "termsOfServiceLabel": "string",            "termsOfServiceUrl": "string",            "title": "string"          },          "preferencesModal": {            "acceptAllBtn": "string",            "additionalInfo": {              "body": "string",              "title": "string"            },            "closeIconLabel": "string",            "rejectAllBtn": "string",            "savePreferencesBtn": "string",            "sections": [              {                "cookieTable": {                  "body": [                    {                      "key": "string",                      "value": "string"                    }                  ],                  "caption": "string",                  "headers": [                    {                      "key": "string",                      "value": "string"                    }                  ]                },                "description": "string",                "linkedCategory": "string",                "title": "string"              }            ],            "serviceCounterLabel": "string",            "title": "string"          }        }      }    ]  },  "regions": [    {      "additionalRegions": [        "string"      ],      "name": "string",      "regionCode": "US-CA",      "rule": {        "autoShow": true,        "autoShowDismissConfig": {          "pageCount": 0,          "seconds": 0        },        "autoShowDismissMode": "after_pages",        "autoblockUnknown": true,        "categories": [          {            "key": "string",            "value": {              "autoDisableOnGPC": true,              "enabled": true,              "readOnly": true,              "reloadPage": true            }          }        ],        "disablePageInteraction": true,        "guiOptions": {          "consentModal": {            "buttonLayout": "AcceptAllNecessaryPreferences",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "bottom",            "showCloseIcon": true          },          "cssVariables": {            "buttonBorderRadius": "string",            "footerBg": "string",            "footerColor": "string",            "footerLinkColor": "string",            "footerLinkHoverColor": "string",            "modalBg": "string",            "modalBorderRadius": "string",            "primaryButtonBg": "string",            "primaryButtonColor": "string",            "primaryButtonHoverBg": "string",            "primaryButtonHoverColor": "string",            "primaryTextColor": "string",            "secondaryButtonBg": "string",            "secondaryButtonColor": "string",            "secondaryButtonHoverBg": "string",            "secondaryButtonHoverColor": "string",            "secondaryTextColor": "string",            "toggleOnBg": "string",            "cookieCategoryBlockBg": "string",            "cookieCategoryBlockHoverBg": "string"          },          "preferencesModal": {            "buttonLayout": "AcceptAllRejectAllSave",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "left"          }        },        "hideFromBots": true,        "language": "en",        "mode": "opt_in",        "showVendorsInPreferences": true,        "translations": [          {            "language": "en",            "value": {              "consentModal": {                "acceptAllBtn": "string",                "closeIconLabel": "string",                "description": "string",                "footer": "string",                "gpcNotification": "string",                "privacyPolicyLabel": "string",                "privacyPolicyUrl": "string",                "rejectAllBtn": "string",                "revisionMessage": "string",                "showPreferencesBtn": "string",                "termsOfServiceLabel": "string",                "termsOfServiceUrl": "string",                "title": "string"              },              "preferencesModal": {                "acceptAllBtn": "string",                "additionalInfo": {                  "body": "string",                  "title": "string"                },                "closeIconLabel": "string",                "rejectAllBtn": "string",                "savePreferencesBtn": "string",                "sections": [                  {                    "cookieTable": {                      "body": [                        {                          "key": "string",                          "value": "string"                        }                      ],                      "caption": "string",                      "headers": [                        {                          "key": "string",                          "value": "string"                        }                      ]                    },                    "description": "string",                    "linkedCategory": "string",                    "title": "string"                  }                ],                "serviceCounterLabel": "string",                "title": "string"              }            }          }        ]      }    }  ]}
DELETE
/rest/v1/consent-settings/{id}
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/rest/v1/consent-settings/string"
{  "id": "string",  "name": "string",  "kind": "string",  "status": "Disabled",  "createdAt": "string",  "updatedAt": "string",  "whitelistDomains": [    "string"  ],  "consentCookieName": "string",  "deviceIdCookieName": "string",  "webSDKToken": "string",  "customDomain": "string",  "revision": 0,  "skipBlockingClassNames": [    "string"  ],  "services": [    {      "additionalCategories": [        "string"      ],      "category": "string",      "domainPatterns": [        "string"      ],      "internalNotes": "string",      "label": "string"    }  ],  "categories": [    {      "label": "string",      "priority": 0,      "value": "string"    }  ],  "default": {    "autoShow": true,    "autoShowDismissConfig": {      "pageCount": 0,      "seconds": 0    },    "autoShowDismissMode": "after_pages",    "autoblockUnknown": true,    "categories": [      {        "key": "string",        "value": {          "autoDisableOnGPC": true,          "enabled": true,          "readOnly": true,          "reloadPage": true        }      }    ],    "disablePageInteraction": true,    "guiOptions": {      "consentModal": {        "buttonLayout": "AcceptAllNecessaryPreferences",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "bottom",        "showCloseIcon": true      },      "cssVariables": {        "buttonBorderRadius": "string",        "footerBg": "string",        "footerColor": "string",        "footerLinkColor": "string",        "footerLinkHoverColor": "string",        "modalBg": "string",        "modalBorderRadius": "string",        "primaryButtonBg": "string",        "primaryButtonColor": "string",        "primaryButtonHoverBg": "string",        "primaryButtonHoverColor": "string",        "primaryTextColor": "string",        "secondaryButtonBg": "string",        "secondaryButtonColor": "string",        "secondaryButtonHoverBg": "string",        "secondaryButtonHoverColor": "string",        "secondaryTextColor": "string",        "toggleOnBg": "string",        "cookieCategoryBlockBg": "string",        "cookieCategoryBlockHoverBg": "string"      },      "preferencesModal": {        "buttonLayout": "AcceptAllRejectAllSave",        "equalWeightButtons": true,        "flipButtons": true,        "layout": "bar",        "position": "left"      }    },    "hideFromBots": true,    "language": "en",    "mode": "opt_in",    "showVendorsInPreferences": true,    "translations": [      {        "language": "en",        "value": {          "consentModal": {            "acceptAllBtn": "string",            "closeIconLabel": "string",            "description": "string",            "footer": "string",            "gpcNotification": "string",            "privacyPolicyLabel": "string",            "privacyPolicyUrl": "string",            "rejectAllBtn": "string",            "revisionMessage": "string",            "showPreferencesBtn": "string",            "termsOfServiceLabel": "string",            "termsOfServiceUrl": "string",            "title": "string"          },          "preferencesModal": {            "acceptAllBtn": "string",            "additionalInfo": {              "body": "string",              "title": "string"            },            "closeIconLabel": "string",            "rejectAllBtn": "string",            "savePreferencesBtn": "string",            "sections": [              {                "cookieTable": {                  "body": [                    {                      "key": "string",                      "value": "string"                    }                  ],                  "caption": "string",                  "headers": [                    {                      "key": "string",                      "value": "string"                    }                  ]                },                "description": "string",                "linkedCategory": "string",                "title": "string"              }            ],            "serviceCounterLabel": "string",            "title": "string"          }        }      }    ]  },  "regions": [    {      "additionalRegions": [        "string"      ],      "name": "string",      "regionCode": "US-CA",      "rule": {        "autoShow": true,        "autoShowDismissConfig": {          "pageCount": 0,          "seconds": 0        },        "autoShowDismissMode": "after_pages",        "autoblockUnknown": true,        "categories": [          {            "key": "string",            "value": {              "autoDisableOnGPC": true,              "enabled": true,              "readOnly": true,              "reloadPage": true            }          }        ],        "disablePageInteraction": true,        "guiOptions": {          "consentModal": {            "buttonLayout": "AcceptAllNecessaryPreferences",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "bottom",            "showCloseIcon": true          },          "cssVariables": {            "buttonBorderRadius": "string",            "footerBg": "string",            "footerColor": "string",            "footerLinkColor": "string",            "footerLinkHoverColor": "string",            "modalBg": "string",            "modalBorderRadius": "string",            "primaryButtonBg": "string",            "primaryButtonColor": "string",            "primaryButtonHoverBg": "string",            "primaryButtonHoverColor": "string",            "primaryTextColor": "string",            "secondaryButtonBg": "string",            "secondaryButtonColor": "string",            "secondaryButtonHoverBg": "string",            "secondaryButtonHoverColor": "string",            "secondaryTextColor": "string",            "toggleOnBg": "string",            "cookieCategoryBlockBg": "string",            "cookieCategoryBlockHoverBg": "string"          },          "preferencesModal": {            "buttonLayout": "AcceptAllRejectAllSave",            "equalWeightButtons": true,            "flipButtons": true,            "layout": "bar",            "position": "left"          }        },        "hideFromBots": true,        "language": "en",        "mode": "opt_in",        "showVendorsInPreferences": true,        "translations": [          {            "language": "en",            "value": {              "consentModal": {                "acceptAllBtn": "string",                "closeIconLabel": "string",                "description": "string",                "footer": "string",                "gpcNotification": "string",                "privacyPolicyLabel": "string",                "privacyPolicyUrl": "string",                "rejectAllBtn": "string",                "revisionMessage": "string",                "showPreferencesBtn": "string",                "termsOfServiceLabel": "string",                "termsOfServiceUrl": "string",                "title": "string"              },              "preferencesModal": {                "acceptAllBtn": "string",                "additionalInfo": {                  "body": "string",                  "title": "string"                },                "closeIconLabel": "string",                "rejectAllBtn": "string",                "savePreferencesBtn": "string",                "sections": [                  {                    "cookieTable": {                      "body": [                        {                          "key": "string",                          "value": "string"                        }                      ],                      "caption": "string",                      "headers": [                        {                          "key": "string",                          "value": "string"                        }                      ]                    },                    "description": "string",                    "linkedCategory": "string",                    "title": "string"                  }                ],                "serviceCounterLabel": "string",                "title": "string"              }            }          }        ]      }    }  ]}
GET
/rest/v1/consent-settings/{id}/analytics
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/string/analytics?from=2026-04-01&to=2026-04-30"
{  "items": [    {      "periodFrom": "string",      "periodTo": "string",      "partialPeriod": true,      "dateTime": "string",      "bannerViews": 0,      "explicitOptIns": 0,      "explicitOptOuts": 0,      "closeIconClicks": 0,      "optInRate": 0,      "optOutRate": 0,      "previousBannerViews": 0,      "previousExplicitOptIns": 0,      "previousExplicitOptOuts": 0,      "previousCloseIconClicks": 0,      "previousOptInRate": 0,      "previousOptOutRate": 0,      "percentageChangeBannerViews": 0,      "percentageChangeExplicitOptIns": 0,      "percentageChangeExplicitOptOuts": 0,      "percentageChangeCloseIconClicks": 0    }  ],  "totals": {    "bannerViews": 0,    "explicitOptIns": 0,    "explicitOptOuts": 0,    "closeIconClicks": 0,    "optInRate": 0,    "optOutRate": 0  }}
GET
/rest/v1/consent-settings/analytics-overview
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/analytics-overview?from=2019-08-24&to=2019-08-24"
{  "items": [    {      "bannerViews": 0,      "explicitOptIns": 0,      "explicitOptOuts": 0,      "closeIconClicks": 0,      "optInRate": 0,      "optOutRate": 0,      "dateTime": "2019-08-24T14:15:22Z",      "periodFrom": "2019-08-24",      "periodTo": "2019-08-24",      "partialPeriod": true    }  ],  "totals": {    "bannerViews": 0,    "explicitOptIns": 0,    "explicitOptOuts": 0,    "closeIconClicks": 0,    "optInRate": 0,    "optOutRate": 0  }}
GET
/rest/v1/consent-settings/{id}/analytics-monthly
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/string/analytics-monthly?from=2026-04-01&to=2026-04-30"
{  "items": [    {      "dateTime": "string",      "periodFrom": "string",      "periodTo": "string",      "partialPeriod": true,      "bannerViews": 0,      "explicitOptIns": 0,      "explicitOptOuts": 0,      "closeIconClicks": 0,      "optInRate": 0,      "optOutRate": 0    }  ]}
GET
/rest/v1/consent-settings/analytics-capabilities
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/analytics-capabilities"
{  "policyVersion": "string",  "expiresAt": "string",  "intervals": [    {      "granularity": "DAILY",      "maxIncludedDays": 0,      "comparisonSupported": true    }  ]}
GET
/rest/v1/consent-settings/{id}/page-analysis
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/string/page-analysis?from=2026-04-01&to=2026-04-30"
{  "entities": [    {      "page": "string",      "bannerViews": 0,      "optOuts": 0,      "closeIconClicks": 0,      "optOutRate": 0    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}
GET
/rest/v1/consent-settings/{id}/analytics-by-region
AuthorizationBearer <token>

Ours Privacy API key

In: header

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/consent-settings/string/analytics-by-region?from=2026-04-01&to=2026-04-30"
{  "regions": [    {      "regionName": "string",      "bannerViews": 0,      "explicitOptIns": 0,      "explicitOptOuts": 0,      "closeIconClicks": 0,      "optInRate": 0,      "optOutRate": 0    }  ]}

How is this guide?