This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.
v3 API//
- Create a consent category
Get all the consent categories assigned to an audit
Update the consent categories assigned to an audit
Retrieve all consent categories snapshots that are applied to a specific audit run.
upload categories found in the csv file uploaded previously
See preview of file content of consent categories uploaded in csv file
Get all consent categories in the account
Get a consent category
Update a consent category
Delete a consent category
Upsert notes for the given Consent Category
Get all tag entries of a consent category
Patch consent category tag entries
Get all request domains of a consent category
Patch consent category request domains
Reprocess consent-category for the selected auditId and runIds
Get all cookies of a consent category
Patch consent category cookie entries
Get audits assigned to the consent category
Modify audit attachments
Get all labels attached to specified consent category
Patch labels attached to specified consent category
request an export of all consent categories in the account
Create a consent category
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
- ObservePoint Production APIhttps://api.observepoint.com/v3/consent-categories/library
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/consent-categories/library?page=0&pageSize=100&name=string&labels=0&type=approved&cmpVendor=ONE_TRUST&sortBy=name&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "metadata": { "pagination": { … } }, "consentCategories": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/consent-categories
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.observepoint.com/v3/consent-categories \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"notes": "string",
"type": "approved",
"isDefaultCC": true,
"cmpData": {
"cmpVendor": "ONE_TRUST",
"oneTrustCookieGroupDescription": "string",
"oneTrustCookieGroupDomain": "observepoint.com",
"oneTrustCookieGroupId": "C001",
"oneTrustCookieGroupGeo": "us, ut",
"sourceUrl": "https://example.com"
}
}'Response
application/json
{ "name": "string", "notes": "string", "type": "approved", "id": 3301, "isDefaultCC": true, "cmpData": { "cmpVendor": "ONE_TRUST", "oneTrustCookieGroupDescription": "string", "oneTrustCookieGroupDomain": "observepoint.com", "oneTrustCookieGroupId": "C001", "oneTrustCookieGroupGeo": "us, ut", "sourceUrl": "https://example.com" }, "updatedType": "ONETRUST_IMPORT", "updatedAt": "2019-08-24T14:15:22Z" }
- ObservePoint Production APIhttps://api.observepoint.com/v3/consent-categories/{consentCategoryId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/consent-categories/3301 \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "name": "string", "notes": "string", "type": "approved", "id": 3301, "isDefaultCC": true, "cmpData": { "cmpVendor": "ONE_TRUST", "oneTrustCookieGroupDescription": "string", "oneTrustCookieGroupDomain": "observepoint.com", "oneTrustCookieGroupId": "C001", "oneTrustCookieGroupGeo": "us, ut", "sourceUrl": "https://example.com" }, "updatedType": "ONETRUST_IMPORT", "updatedAt": "2019-08-24T14:15:22Z" }