Cookie Privacy report endpoints

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

Cookie Inventory Report

Cookie Inventory report endpoints

Operations

Cookie Privacy report endpoints

Cookie privacy report

Operations

Get Cookie Privacy summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy

Security

API_Key

Path

auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239

runIdinteger(int64)required

Unique identification number for web audit or journey run

Example: 33010

Bodyapplication/json

Filters applicable to Cookie Privacy report

pageUrlobject

finalPageUrlobject

pageTitleobject

initialPageStatusCodeobject

finalPageStatusCodeobject

combinedPageStatusCodestring

broken - initial or final URL are broken,
good - initial URL is good or redirect and final URL is good

Enum"broken""good"

pageLoadTimeobject

Page load time in milliseconds. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

pageSizeobject

Page size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

redirectCountobject

Number of redirects for a page. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

hasBrokenLinksboolean

pageUrlMatchingAuditFilterConfigurationboolean

cookieOriginInclusionstring

exclude_pre_audit_action_only_cookies - exclude cookies which were only changed during pre-audit actions

Value"exclude_pre_audit_action_only_cookies"

cookieNameobject

cookieDomainobject

consentCategoryIdinteger

ID of consent category

Example: 3301

consentCategorySnapshotIdinteger(int64)

Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run

Example: 33010

consentCategoryComplianceStatusstring

Enum"approved""unapproved"

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/cookie-privacy \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageUrl": {
      "filterType": "contains",
      "filterValue": "string",
      "negated": false
    },
    "finalPageUrl": {
      "filterType": "contains",
      "filterValue": "string",
      "negated": false
    },
    "pageTitle": {
      "filterType": "contains",
      "filterValue": "ObserveP"
    },
    "initialPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageUrlMatchingAuditFilterConfiguration": true,
    "cookieOriginInclusion": "exclude_pre_audit_action_only_cookies",
    "cookieName": {
      "filterType": "contains",
      "filterValue": "string"
    },
    "cookieDomain": {
      "filterType": "contains",
      "filterValue": "string"
    },
    "consentCategoryId": 3301,
    "consentCategorySnapshotId": 33010,
    "consentCategoryComplianceStatus": "approved"
  }'

Responses

Cookie Privacy summary data

Bodyapplication/json

totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

totalUniqueCookieCountintegerrequired

Total number of unique cookies discovered. Cookie uniqueness determined by cookie name and domain

filteredUniqueCookieCountintegerrequired

Number of unique cookies passing all applied filters

totalApprovedCookieCountintegerrequired

Total number of approved cookies discovered

filteredApprovedCookieCountintegerrequired

Number of approved cookies passing all applied filters

totalUnapprovedCookieCountintegerrequired

Total number of unapproved cookies discovered

filteredUnapprovedCookieCountintegerrequired

Number of unapproved cookies passing all applied filters

filteredPageWithUnapprovedCookieCountintegerrequired

Number of pages with unapproved cookies passing all applied filters

runHasNoConsentCategoriesAssignedbooleanrequired

When TRUE, run did not have any consent categories assigned. When NOT specified or FALSE, it had at least one.

Response

application/json

{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalUniqueCookieCount": 0,
  "filteredUniqueCookieCount": 0,
  "totalApprovedCookieCount": 0,
  "filteredApprovedCookieCount": 0,
  "totalUnapprovedCookieCount": 0,
  "filteredUnapprovedCookieCount": 0,
  "filteredPageWithUnapprovedCookieCount": 0,
  "runHasNoConsentCategoriesAssigned": true
}

Get Cookie Privacy trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/cookie-privacy/trends

Security

API_Key

Path

auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239

runIdinteger(int64)required

Unique identification number for web audit or journey run

Example: 33010

curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/cookie-privacy/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Cookie Privacy trends data

Bodyapplication/json

runsArray of objects<= 5 itemsrequired

runs[].runIdinteger(int64)required

Example: 33010

runs[].completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

An uppercase T must separate the date and time portions.
An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"

runs[].totalUniqueCookieCountintegerrequired

Total number of unique cookies discovered. Cookie uniqueness determined same as in Cookie Inventory

runs[].totalApprovedCookieCountintegerrequired

Total number of approved cookies found in audit run

runs[].totalUnapprovedCookieCountintegerrequired

Total number of unapproved cookies found in audit run

Response

application/json

{
  "runs": [
    { … }
  ]
}

Get Cookie Privacy specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/reports/cookie-privacy/trends/{trendName}

Security

API_Key

Path

auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239

trendNamestringrequired

name of requested trend

Enum"unique_cookies""approved_cookies""unapproved_cookies"

Query

daysinteger[ 1 .. 390 ]required

Number of days to get trend values for, relative to current time

curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/reports/cookie-privacy/trends/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Cookie Privacy specific trend values

Bodyapplication/json

runsArray of objectsrequired

runs[].runIdinteger(int64)required

Example: 33010

runs[].completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

An uppercase T must separate the date and time portions.
An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"

runs[].trendValuenumberrequired

Response

application/json

{
  "runs": [
    { … }
  ]
}

File Changes Report

File changes report endpoints

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

Page Summary Report

Page Summary report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Web Journey Cookie Report

Cookie analysis and reporting for web journeys

Operations

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run data

Operations

Consent Category Export

Export consent category data

Operations

Exports Center

Access requested exports status/information

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Web Journey Run Export

Export web journey run data

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations

Account Usage

Account usage data

Operations

Email Inbox Configuration

APIs for managing email inbox configurations and setting

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inboxes

APIs for getting email messages and results from email inboxes

Operations

Action Set Action Rules

APIs for managing Action Set Action Rules

Operations

Action Set Actions

APIs for managing Action Set Actions

Operations

Action Sets

APIs for managing Action Sets

Operations

Audit Actions

APIs for managing audit actions

Operations

Audit Blocking Config

APIs for managing audit request blocking configuration

Operations

Audit Login Actions

APIs for managing audit login actions

Operations

Audits Consent Category

APIs for managing audit consent categories

Operations

Audits Management

APIs for managing audits

Operations

Consent Categories

APIs for managing Consent Categories

Operations

Custom Headers

APIs for managing custom HTTP header groups

Operations

Data Sources

APIs for managing Data Sources

Operations

Geo Locations

APIs for geo locations

Operations

Notification Center

Find and manage email subscriptions

Operations

Remote File Mappings

APIs for managing Remote File Mappings

Operations

Rules

APIs for managing rules

Operations

Schedules

APIs for item schedules and calendars

Operations

Site Censuses

APIs for managing Site Census

Operations

User Events

APIs for managing User Events

Operations

Web Journey Blocking Config

APIs for managing web journey request blocking configuration

Operations

Web Journey Custom Headers

APIs for managing web journey custom headers

Operations

Web Journeys Management

APIs for managing Web Journeys

Operations

V3 APICopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Alert Summary Report

Audit Summary Report

Browser Logs Report

Cookie Inventory Report

Cookie Privacy report endpoints

Get Cookie Privacy summary for specified audit run

RequestExpand all

Responses

Was this helpful?

Get Cookie Privacy trends relative to specified audit run

Request

Responses

Was this helpful?

Get Cookie Privacy specific trend values relative to current day

Request

Responses

Was this helpful?

File Changes Report

Page Details Report

Page Summary Report

Request Privacy Report

Rule Summary Report

Tag Duplicates and Multiples Report

Tag Health Report

Tag Inventory Report

Tag Privacy Report

Variable Inventory Report

Audit Run Data

Web Journey Cookie Report

Account Usage Export

Alert Export

Audit Run Export

Consent Category Export

Exports Center

Manual Journey Run Export

Scheduled Exports

Web Journey Run Export

Account's Triggered Alerts

Account Usage Alerts

Alerts

Email Inbox Message Alerts

Account Usage

Email Inbox Configuration

Email Inbox Messages

Email Inboxes

Action Set Action Rules

Action Set Actions

Action Sets

Audit Actions

Audit Blocking Config

Audit Login Actions

Audits Consent Category

Audits Management

Consent Categories

Custom Headers

Data Sources

Geo Locations

Notification Center

Remote File Mappings

Rules

Schedules

Site Censuses

User Events

Web Journey Blocking Config

Web Journey Custom Headers

Web Journeys Management

V3 API
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request