Skip to content
v3 API/
/
Get audit configuration i...

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

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

run audit now

Request

POST /v3/web-audits/{auditId}/runs
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
Bodyapplication/jsonrequired

Run the audit now. The request must contain the web-audit ID. Unlike v2 "run now" API, this API does not reject run requests if there is an active run.

startingUrlsArray of strings or null>= 0 items
callbackWorkflowEventTypestringrequired

The workflow file to be used in for starting the callback workflow Has to be a file name without extension, e.g. "audit-complete" instead of "audit-complete.yml"

callbackRepositoryOwnerstringrequired

The owner of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow

callbackRepositoryNamestringrequired

The name of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow

callbackContextobject

Contains a context for the callback URL to be used in the run

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "startingUrls": [
      "string"
    ],
    "callbackWorkflowEventType": "string",
    "callbackRepositoryOwner": "string",
    "callbackRepositoryName": "string",
    "callbackContext": {}
  }'

Responses

Run started successfully

Response
No content

Get audit configuration info for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/info
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
Query
includeFiltersboolean

Include filters in the response

Default false
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/info?includeFilters=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit run configuration info

Bodyapplication/json
blockThirdPartyCookiesbooleanrequired

When true the browser blocks all third-party cookies

browserNamestringrequired

Browser name

browserVersionstringrequired

Browser version

customProxystringrequired

The custom proxy used for the audit

discoverSitemapsbooleanrequired

When true, the audit discovers sitemaps on any domains for starting URLs and uses those to find URLs to scan

sitemapDataobject

Data about sitemaps that were discovered and visited by the audit

filtersobjectrequired

Filters used for the audit to include and exclude urls to be scanned

filters.​includeFiltersArray of strings(regex)required

List of include filters

Example: ["^https?://([^/:\\?]*\\.)?google.com"]
filters.​excludeFiltersArray of strings(regex)required

List of exclude filters

Example: ["/careers"]
gpcEnabledbooleanrequired

GPC enabled or not

heightintegerrequired

Browser height in pixels

loginActionsbooleanrequired

Pre-Audit Actions present in configuration or not

locationIdintegerrequired

Location (Proxy) ID, this maps to a location in the location table

locationNamestringrequired

Location human readable name. This field maps to the db location.label

Example: "England, London"
onPageActionsbooleanrequired

On Page Actions present in configuration or not

privacyConsentActionsbooleanrequired

Privacy Consent Actions present in configuration or not

runDurationintegerrequired

Run duration in seconds

scanSpeedintegerrequired

Scan speed is the number of engines the customer requests to run the audit with Currently a value between 1-50 is supported, but not guaranteed.

startingUrlCountnumberrequired
urlsScannedintegerrequired

Number of URLs scanned

userAgentstringrequired

User agent

vpnEnabledbooleanrequired

VPN enabled or not for the run configuration

widthintegerrequired

Browser width in pixels

technologyBlockingEnabledbooleanrequired

Tag ID/Tag Category ID blocking enabled or not

fileSubstitutionConfiguredbooleanrequired

File Substitution configured or not

customHeadersAppliedbooleanrequired

Custom HTTP headers applied or not

auditStoppedByUserIdinteger or null(int64)

ID of the user who stopped the audit run early, if applicable

Response
application/json
{
  "blockThirdPartyCookies": true,
  "browserName": "string",
  "browserVersion": "string",
  "customProxy": "string",
  "discoverSitemaps": true,
  "sitemapData": {
    "sitemapsScannedCount": 0,
    "sitemapsScanned": [ … ],
    "sitemapsBrokenCount": 0,
    "sitemapsBrokenUrls": [ … ]
  },
  "filters": {
    "includeFilters": [ … ],
    "excludeFilters": [ … ]
  },
  "gpcEnabled": true,
  "height": 0,
  "loginActions": true,
  "locationId": 0,
  "locationName": "England, London",
  "onPageActions": true,
  "privacyConsentActions": true,
  "runDuration": 0,
  "scanSpeed": 0,
  "startingUrlCount": 0,
  "urlsScanned": 0,
  "userAgent": "string",
  "vpnEnabled": true,
  "width": 0,
  "technologyBlockingEnabled": true,
  "fileSubstitutionConfigured": true,
  "customHeadersApplied": true,
  "auditStoppedByUserId": 0
}

Get all the consent categories assigned to an audit

Request

GET /v3/web-audits/{auditId}/consent-categories
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/consent-categories \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return a list of consent-categories assigned to an audit

Bodyapplication/json
consentCategoriesArray of objectsrequired
consentCategories[].​namestring
consentCategories[].​notesstring
consentCategories[].​typestring
Enum"approved""unapproved"
consentCategories[].​idinteger

ID of consent category

Example: 3301
consentCategories[].​isDefaultCCboolean

If true, this is the default consent category

consentCategories[].​cmpDataobject
consentCategories[].​updatedTypestring
Enum"ONETRUST_IMPORT""FILE_IMPORT""APP_CREATE"
consentCategories[].​updatedAtstring(date-time)

The last time this consent category was updated in UTC timezone

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

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