Skip to content

V3 API

This section documents the V3 Reporting API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, and analyze web performance metrics from your ObservePoint scans.

Languages
Servers
ObservePoint Production API

https://api.observepoint.com/

Audit Run Data

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

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

Audit Summary Report

Audit Summary report endpoints

Operations

Alert Summary Report

Alert Summary report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Exports Center

Access requested exports status/information

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Audit Run Export

Export audit run data

Operations

Web Journey Run Export

Export web journey run data

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Alerts

Alert management and configuration

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations
Operations
Operations

Account Usage Alerts

Alerts related to account usage

Operations

Account Usage Export

Export account usage data

Operations

Request

POST /v3/usage/exports/{exportType}
Security
API_Key
Path
exportTypestringrequired

Controls accepted values

Enum"AUDIT_RUNS_EXPORT""WEB_JOURNEY_RUNS_EXPORT"
Bodyapplication/json

Filters

object

Exact type depends on exportType param, see mapping in AccountUsageExportTypeToFilterMapping

curl -i -X POST \
  'https://api.observepoint.com/v3/usage/exports/{exportType}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Details of created export

Bodyapplication/json
exportIdinteger(int64)required

Unique ID of an export

Response
application/json
{ "exportId": 0 }

Notification Center

Find and manage email subscriptions

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations