Skip to content
v3 API/
/
Starts data-collection fo...

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

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

Returns a preview of the current census results data given specific path patterns

Request

POST /v3/site-censuses/{censusId}/current-results/url-preview
Security
API_Key
Path
censusIdinteger(int64)required

Unique identification number for a site census

Bodyapplication/jsonrequired

The URL pattern for which a preview is desired

fqdnstringrequired

The fully qualified domain name (FQDN) of the URL pattern.

renderedPathPatternstringrequired

The rendered path of the URL pattern with the dynamic segment character. Not meant for display.

curl -i -X POST \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/current-results/url-preview' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fqdn": "string",
    "renderedPathPattern": "string"
  }'

Responses

Successful operation

Bodyapplication/json
censusIdinteger(int64)required

The unique identifier for the Site Census.

totalUrlsintegerrequired
urlsArray of strings>= 0 itemsrequired
Response
application/json
{
  "censusId": 0,
  "totalUrls": 0,
  "urls": [
    "string"
  ]
}

Starts data-collection for a given census

Request

POST /v3/site-censuses/{censusId}/start
Security
API_Key
Path
censusIdinteger(int64)required

Unique identification number for a site census

curl -i -X POST \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/start' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation, census started

Bodyapplication/json
idinteger(int64)required

The unique identifier for the Site Census.

accountIdinteger(int64)

The account ID associated with the Site Census.

namestringrequired

The name of the Site Census.

autoPauseAfterinteger[ 1 .. 10080 ]required

The max time the scan will run, in minutes.

ownerIdinteger(int64)

The userId of the user who created the Site Census.

currentScanStartedAtstring or null(date-time)

The date and time when the current scan session started.

lastScanStoppedAtstring or null(date-time)

The date and time when the last scan session stopped.

notificationEmailsArray of strings(email)>= 0 itemsrequired

Target email addresses for notification when this census auto-pauses or runs out of URLs.

startingUrlsArray of strings(uri)>= 0 itemsrequired

The list of starting URLs for the Site Census.

filterPatternsArray of objects>= 0 itemsrequired
filterPatterns[].​pathPatternstringrequired

The GLOB pattern to match the path of the URL.

filterPatterns[].​fqdnstringrequired

The fully qualified domain name (FQDN) to match against the URL.

filterPatterns[].​typestringrequired

Indicates whether matches should be prioritized or ignored.

Enum"PRIORITY""IGNORE"
Response
application/json
{
  "id": 0,
  "accountId": 0,
  "name": "string",
  "autoPauseAfter": 1,
  "ownerId": 0,
  "currentScanStartedAt": "2019-08-24T14:15:22Z",
  "lastScanStoppedAt": "2019-08-24T14:15:22Z",
  "notificationEmails": [
    "user@example.com"
  ],
  "startingUrls": [
    "http://example.com"
  ],
  "filterPatterns": [
    { … }
  ]
}

Stops data-collection for a given census

Request

POST /v3/site-censuses/{censusId}/stop
Security
API_Key
Path
censusIdinteger(int64)required

Unique identification number for a site census

curl -i -X POST \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation, census stopped

Bodyapplication/json
idinteger(int64)required

The unique identifier for the Site Census.

accountIdinteger(int64)

The account ID associated with the Site Census.

namestringrequired

The name of the Site Census.

autoPauseAfterinteger[ 1 .. 10080 ]required

The max time the scan will run, in minutes.

ownerIdinteger(int64)

The userId of the user who created the Site Census.

currentScanStartedAtstring or null(date-time)

The date and time when the current scan session started.

lastScanStoppedAtstring or null(date-time)

The date and time when the last scan session stopped.

notificationEmailsArray of strings(email)>= 0 itemsrequired

Target email addresses for notification when this census auto-pauses or runs out of URLs.

startingUrlsArray of strings(uri)>= 0 itemsrequired

The list of starting URLs for the Site Census.

filterPatternsArray of objects>= 0 itemsrequired
filterPatterns[].​pathPatternstringrequired

The GLOB pattern to match the path of the URL.

filterPatterns[].​fqdnstringrequired

The fully qualified domain name (FQDN) to match against the URL.

filterPatterns[].​typestringrequired

Indicates whether matches should be prioritized or ignored.

Enum"PRIORITY""IGNORE"
Response
application/json
{
  "id": 0,
  "accountId": 0,
  "name": "string",
  "autoPauseAfter": 1,
  "ownerId": 0,
  "currentScanStartedAt": "2019-08-24T14:15:22Z",
  "lastScanStoppedAt": "2019-08-24T14:15:22Z",
  "notificationEmails": [
    "user@example.com"
  ],
  "startingUrls": [
    "http://example.com"
  ],
  "filterPatterns": [
    { … }
  ]
}

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