Skip to content
/Request Privacy Report

V3 API

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.

Download OpenAPI description
combined.openapi.json
combined.openapi.yaml
Overview
URL
https://www.observepoint.com/contact-us
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

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

Get Request Privacy summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/request-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 Request 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
pageSizeobject
redirectCountobject
hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
requestDomainstring

Network request URL domain

Example: "example.com"
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"
countryCodestring

ISO 3166-1 (Alpha-2) country code

Example: "US"
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/request-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,
    "requestDomain": "example.com",
    "consentCategoryId": 3301,
    "consentCategorySnapshotId": 33010,
    "consentCategoryComplianceStatus": "approved",
    "countryCode": "US"
  }'

Responses

Request Privacy summary data

Bodyapplication/json
totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

totalRequestCountintegerrequired

Total number of network requests discovered

filteredRequestCountintegerrequired

Number of network request passing all applied filters

filteredUniqueRequestDomainCountintegerrequired

Number of unique network request domains passing all applied filters

filteredUniqueRequestGeoCountintegerrequired

Number of unique network request geolocations passing all applied filters

totalUniqueApprovedRequestDomainCountintegerrequired

Total number of unique approved request domains discovered

filteredUniqueApprovedRequestDomainCountintegerrequired

Number of unique approved request domains passing all applied filters

totalUniqueUnapprovedRequestDomainCountintegerrequired

Total number of unique unapproved domains discovered

filteredUniqueUnapprovedRequestDomainCountintegerrequired

Number of unique unapproved domains passing all applied filters

filteredPageWithUnapprovedRequestCountintegerrequired

Number of pages with unapproved domains or geos 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.

totalApprovedRequestCountintegerDeprecatedrequired

Total number of approved domain+geo pairs discovered

filteredApprovedRequestCountintegerDeprecatedrequired

Number of approved domain+geo pairs passing all applied filters

totalUnapprovedRequestCountintegerDeprecatedrequired

Total number of unapproved domain+geo pairs discovered

filteredUnapprovedRequestCountintegerDeprecatedrequired

Number of unapproved domain+geo pairs passing all applied filters

Response
application/json
{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalRequestCount": 0,
  "filteredRequestCount": 0,
  "filteredUniqueRequestDomainCount": 0,
  "filteredUniqueRequestGeoCount": 0,
  "totalApprovedRequestCount": 0,
  "totalUniqueApprovedRequestDomainCount": 0,
  "filteredApprovedRequestCount": 0,
  "filteredUniqueApprovedRequestDomainCount": 0,
  "totalUnapprovedRequestCount": 0,
  "totalUniqueUnapprovedRequestDomainCount": 0,
  "filteredUnapprovedRequestCount": 0,
  "filteredUniqueUnapprovedRequestDomainCount": 0,
  "filteredPageWithUnapprovedRequestCount": 0,
  "runHasNoConsentCategoriesAssigned": true
}

Get Request Privacy trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/request-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/request-privacy/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Request 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:

  1. An uppercase T must separate the date and time portions.
  2. 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[].​totalRequestCountintegerrequired

Total number of network requests discovered

runs[].​totalUniqueRequestDomainCountintegerrequired

Total number of unique network request domains discovered

runs[].​totalUniqueRequestGeoCountintegerrequired

Total number of unique network request geolocations discovered

runs[].​totalUniqueApprovedRequestDomainCountintegerrequired

Total number of unique approved request domains discovered

runs[].​totalUniqueUnapprovedRequestDomainCountintegerrequired

Total number of unique unapproved domains discovered

runs[].​totalApprovedRequestCountintegerDeprecatedrequired

Total number of approved domain+geo pairs discovered

runs[].​totalUnapprovedRequestCountintegerDeprecatedrequired

Total number of unapproved domain+geo pairs discovered

Response
application/json
{
  "runs": [
    { … }
  ]
}

Get Request Privacy specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/reports/request-privacy/trends/{trendName}
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
trendNamestringrequired

name of requested trend

Enum"request_count""unique_domains""unique_geos""approved_requests""unique_approved_domains""unapproved_requests""unique_unapproved_domains"
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/request-privacy/trends/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Request 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:

  1. An uppercase T must separate the date and time portions.
  2. 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": [
    { … }
  ]
}

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

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run 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 Management

APIs for managing audits

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