How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ObservePoint Consent Categories API

APIs for managing Consent Categories

ObservePoint Consent Categories API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include consent-categories. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 15 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.observepoint.com.

23 operations 15 paths 43 schemas 1 DELETE9 GET6 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ObservePoint Consent Categories API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key).

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 23

Across 15 paths, the API surfaces 23 operations — 1 DELETE, 9 GET, 6 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

consent-categories 23

APIs for managing Consent Categories

GET
/v3/web-audits/{auditId}/consent-categories
Get all the consent categories assigned to an audit
getAuditConsentCategories 1 param → 200401403404
PATCH
/v3/web-audits/{auditId}/consent-categories
Update the consent categories assigned to an audit
patchAuditConsentCategories 1 param body → 200401403404
GET
/v3/web-audits/{auditId}/runs/{runId}/consent-categories
Retrieve all consent categories snapshots that are applied to a specific audit run.
getAuditRunConsentCategories 2 params → 200401403404
POST
/v3/consent-categories/upload
Create or update consent categories found in the file uploaded previously
uploadConsentCategories body → 200401403404
POST
/v3/consent-categories/upload/preview
Upload a file with consent category configurations and preview the changes
uploadConsentCategoriesPreview body → 200400401403
GET
/v3/consent-categories/library
Get all consent categories in the account
getConsentCategoryLibrary 8 params → 200401403404
POST
/v3/consent-categories/exportdeprecated
request an export of all consent categories in the account
exportConsentCategories → 204401403404
POST
/v3/consent-categories
Create a consent category
createConsentCategories body → 200400401403404
GET
/v3/consent-categories/{consentCategoryId}
Get a consent category
getConsentCategory 1 param → 200401403404
PUT
/v3/consent-categories/{consentCategoryId}
Update a consent category
updateConsentCategory 1 param body → 200400401403404
DELETE
/v3/consent-categories/{consentCategoryId}
Delete a consent category
deleteConsentCategory 1 param → 204400401403
PUT
/v3/consent-categories/{consentCategoryId}/notes
Upsert notes for the given Consent Category
updateConsentCategoriesNotes 1 param body → 204400401403404
GET
/v3/consent-categories/{consentCategoryId}/tags
Get all tag entries of a consent category
getConsentCategoryTags 1 param → 200401403404
PATCH
/v3/consent-categories/{consentCategoryId}/tags
Patch consent category tag entries
patchConsentCategoryTagEntries 1 param body → 200400401403404
GET
/v3/consent-categories/{consentCategoryId}/request-domains
Get all request domains of a consent category
getConsentCategoryRequestDomains 1 param → 200401403404
PATCH
/v3/consent-categories/{consentCategoryId}/request-domains
Patch consent category request domains
patchConsentCategoryRequestDomains 1 param body → 200400401403404
POST
/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess
Reprocess consent-category for the selected auditId and runIds
reprocessConsentCategories 2 params → 200401403
GET
/v3/consent-categories/{consentCategoryId}/cookies
Get all cookies of a consent category
getConsentCategoryCookieEntries 1 param → 200401403
PATCH
/v3/consent-categories/{consentCategoryId}/cookies
Patch consent category cookie entries
patchConsentCategoryCookieEntries 1 param body → 200400401403404
GET
/v3/consent-categories/{consentCategoryId}/web-audits
Get audits assigned to the consent category
getConsentCategoryAudits 1 param → 200401403404
PATCH
/v3/consent-categories/{consentCategoryId}/web-audits
Modify audit attachments
patchConsentCategoryAudits 1 param body → 200400401403404
GET
/v3/consent-categories/{consentCategoryId}/labels
Get all labels attached to specified consent category
getConsentCategoryAssignedLabels 1 param → 200401403404
PATCH
/v3/consent-categories/{consentCategoryId}/labels
Patch labels attached to specified consent category
patchConsentCategoryAssignedLabels 1 param body → 200400401403404

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are ConsentCategoryDTO (8 properties), ConsentCategory_Cmp_Data (6 properties), ConsentCategory_WebAudits_ItemDTO (6 properties), ConsentCategoryFoundResult (6 properties). Each schema is shown below with its type and property counts.

CookieNameMatchType
string
ConsentCategory_TagEntryResponseDTO
object
1 property
ConsentCategory_TagEntryItemDTO
object
DTO for tag under a consent category bucket
3 properties 2 required
AuditId
integer
ConsentCategory_CreateRequestDTO
object
5 properties 2 required
ConsentCategory_UpdateRequestDTO
object
4 properties 1 required
AttachmentPatchDocument_ItemDTO
object
A JSONPatch document for modifying consent preference attachments
3 properties
ConsentCategory_LibraryResponseDTO
object
2 properties
ConsentCategory_LibraryItemDTO
ConsentCategory_CookieEntryResponseDTO
object
DTO for cookie entry response
1 property 1 required
Label
object
DTO for Labels
2 properties 2 required
WebAudit_ConsentCategorySnapshots_ResponseDTO
object
NOTE: For individual consent category snapshot, Field consentCategoryId is omitted when the consent category is deleted
1 property
PatchDocument_ItemDTO
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
ConsentCategory_TypeEnum
string
LabelId
integer
Label identifier
ConsentCategorySnapshotDTO
object
A consent category snapshot dto
6 properties 5 required
ConsentCategory_Cmp_Data
object
6 properties 4 required
ConsentCategoryLibrarySortByEnum
string
WebAudit_ConsentCategories_ResponseDTO
object
1 property 1 required
PaginationMetadata
object
5 properties 5 required
AttachmentPatchDocument_RequestDTO
array
CookieDomainMatchType
string
ConsentCategoryUploadPreviewResult
object
2 properties 1 required
ConsentCategoryUploadWithLabels
object
3 properties 1 required
ConsentCategoryDTO
object
8 properties
ConsentCategory_RequestDomainItemDTO
object
DTO for request domain under a consent category
4 properties 1 required
ConsentCategory_RequestDomainResponseDTO
object
1 property
ConsentCategory_WebAudits_ResponseDTO
object
1 property
ConsentCategory_VendorTypeEnum
string
LabelResponseDTO
object
DTO for get/patch labels
1 property
PatchDocument_RequestDTO
array
RunId
integer
ConsentCategoryFoundResult
object
6 properties 3 required
ConsentCategory_ItemCountsDTO
object
3 properties
ConsentCategoryId
integer
ID of consent category
ErrorModel
object
4 properties
ConsentCategorySnapshotId
integer
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
ConsentCategory_updatedType
string
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 required
ConsentCategory_CookieEntryItemDTO
object
DTO For Cookie under a consent preference bucket
5 properties
ConsentCategoriesUploadRequest
object
2 properties 2 required
ConsentCategory_WebAudits_ItemDTO
object
6 properties
RequestDomainMatchType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-consent-categories-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
ObservePoint Account Triggered Alerts API
ObservePoint Account Usage Alerts API
ObservePoint Account Usage Export API
ObservePoint Account Usage V2 API
ObservePoint Action Set Action Rules API
ObservePoint Action Set Actions API
ObservePoint Action Sets API
ObservePoint Alert Export API
ObservePoint Alert Summary Report API
ObservePoint Alerts API
ObservePoint Audit Actions API
Where this information came from

This is an independent, third-party profile of ObservePoint Consent Categories API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.