Skip to content
v3 API/
/
Get web journey by ID

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

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

Delete web journeys by domain or folder

Request

DELETE /v3/web-journeys

Delete web journeys by domain ID or folder ID

Security
API_Key
Query
domainIdinteger

Delete all web journeys in the specified domain

Example: domainId=123
folderIdinteger

Delete all web journeys in the specified folder

Example: folderId=456
curl -i -X DELETE \
  'https://api.observepoint.com/v3/web-journeys?domainId=123&folderId=456' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Web journeys deleted successfully

Response
No content

Get web journey by ID

Request

GET /v3/web-journeys/{webJourneyId}

Retrieve a specific web journey by its ID

Security
API_Key
Path
webJourneyIdinteger(int64)required

Unique identification number for web journey item

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

Responses

Web journey retrieved successfully

Bodyapplication/json
idinteger(int64)required

Unique identifier for the web journey

Example: 12345
namestring<= 255 charactersrequired

Name of the web journey

Example: "E-commerce Checkout Flow"
notesstring or null

Optional notes or description

Example: "Tests the complete checkout process"
domainIdintegerrequired

ID of the associated domain

Example: 123
userIdintegerrequired

ID of the user who created this web journey

Example: 456
folderIdinteger or null

ID of the folder containing this web journey

Example: 789
browserWidthinteger or null[ 250 .. 10000 ]

Browser viewport width in pixels

Example: 1920
browserHeightinteger or null[ 250 .. 10000 ]

Browser viewport height in pixels

Example: 1080
loadVideosboolean or null

Whether to load video content

Example: true
vpnEnabledboolean or null

Whether VPN is enabled for this journey

Example: false
gpcEnabledboolean or null

Whether Global Privacy Control is enabled

Example: true
blockThirdPartyCookiesboolean or null

Whether to block third-party cookies

Example: false
frequencystring

Frequency options for web journey execution

Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
Example: "daily"
locationstring or null

Geographic location for the web journey execution

Example: "US-West"
userAgentstring or null

User agent string to use

Example: "Chrome/91.0.4472.124"
userAgentDescriptionstring or null

Human-readable description of the user agent

Example: "Chrome Browser"
customProxystring or null

Custom proxy server configuration

Example: "proxy.example.com:8080"
monitoredByScriptServicesboolean or null

Whether this journey is monitored by script services

Example: true
createdAtstring(date-time)

When the web journey was created

Example: "2023-06-01T10:30:00Z"
nextCheckstring or null(date-time)

When the next execution is scheduled

Example: "2023-06-02T10:30:00Z"
scheduleobject
Response
application/json
{
  "id": 12345,
  "name": "E-commerce Checkout Flow",
  "notes": "Tests the complete checkout process",
  "domainId": 123,
  "userId": 456,
  "folderId": 789,
  "browserWidth": 1920,
  "browserHeight": 1080,
  "loadVideos": true,
  "vpnEnabled": false,
  "gpcEnabled": true,
  "blockThirdPartyCookies": false,
  "frequency": "daily",
  "location": "US-West",
  "userAgent": "Chrome/91.0.4472.124",
  "userAgentDescription": "Chrome Browser",
  "customProxy": "proxy.example.com:8080",
  "monitoredByScriptServices": true,
  "createdAt": "2023-06-01T10:30:00Z",
  "nextCheck": "2023-06-02T10:30:00Z",
  "schedule": {
    "dtStart": "string",
    "tzId": "string",
    "recurrenceRule": "string",
    "isPaused": true,
    "description": "string",
    "presetType": "12_HOUR"
  }
}

Update web journey

Request

PUT /v3/web-journeys/{webJourneyId}

Update an existing web journey

Security
API_Key
Path
webJourneyIdinteger(int64)required

Unique identification number for web journey item

Example: 107239
Bodyapplication/jsonrequired

Updated web journey data

namestring<= 255 characters

Name of the web journey

Example: "E-commerce Checkout Flow"
notesstring or null

Optional notes or description

Example: "Tests the complete checkout process"
domainIdintegerrequired

ID of the associated domain

Example: 123
userIdinteger

ID of the user who created this web journey

Example: 456
folderIdinteger or null

ID of the folder containing this web journey

Example: 789
browserWidthinteger or null[ 250 .. 10000 ]

Browser viewport width in pixels

Example: 1920
browserHeightinteger or null[ 250 .. 10000 ]

Browser viewport height in pixels

Example: 1080
loadVideosboolean or null

Whether to load video content

Example: true
vpnEnabledboolean or null

Whether VPN is enabled for this journey

Example: false
gpcEnabledboolean or null

Whether Global Privacy Control is enabled

Example: true
blockThirdPartyCookiesboolean or null

Whether to block third-party cookies

Example: false
frequencystring

Frequency options for web journey execution

Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
Example: "daily"
locationstring or null

Geographic location for the web journey execution

Example: "US-West"
userAgentstring or null

User agent string to use

Example: "Chrome/91.0.4472.124"
userAgentDescriptionstring or null

Human-readable description of the user agent

Example: "Chrome Browser"
customProxystring or null

Custom proxy server configuration

Example: "proxy.example.com:8080"
monitoredByScriptServicesboolean or null

Whether this journey is monitored by script services

Example: true
nextCheckstring or null(date-time)

When the next execution is scheduled

Example: "2023-06-02T10:30:00Z"
scheduleobject
curl -i -X PUT \
  https://api.observepoint.com/v3/web-journeys/107239 \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "E-commerce Checkout Flow",
    "notes": "Tests the complete checkout process",
    "domainId": 123,
    "userId": 456,
    "folderId": 789,
    "browserWidth": 1920,
    "browserHeight": 1080,
    "loadVideos": true,
    "vpnEnabled": false,
    "gpcEnabled": true,
    "blockThirdPartyCookies": false,
    "frequency": "daily",
    "location": "US-West",
    "userAgent": "Chrome/91.0.4472.124",
    "userAgentDescription": "Chrome Browser",
    "customProxy": "proxy.example.com:8080",
    "monitoredByScriptServices": true,
    "nextCheck": "2023-06-02T10:30:00Z",
    "schedule": {
      "dtStart": "string",
      "tzId": "string",
      "recurrenceRule": "string",
      "isPaused": true
    }
  }'

Responses

Web journey updated successfully

Bodyapplication/json
idinteger(int64)required

Unique identifier for the web journey

Example: 12345
namestring<= 255 charactersrequired

Name of the web journey

Example: "E-commerce Checkout Flow"
notesstring or null

Optional notes or description

Example: "Tests the complete checkout process"
domainIdintegerrequired

ID of the associated domain

Example: 123
userIdintegerrequired

ID of the user who created this web journey

Example: 456
folderIdinteger or null

ID of the folder containing this web journey

Example: 789
browserWidthinteger or null[ 250 .. 10000 ]

Browser viewport width in pixels

Example: 1920
browserHeightinteger or null[ 250 .. 10000 ]

Browser viewport height in pixels

Example: 1080
loadVideosboolean or null

Whether to load video content

Example: true
vpnEnabledboolean or null

Whether VPN is enabled for this journey

Example: false
gpcEnabledboolean or null

Whether Global Privacy Control is enabled

Example: true
blockThirdPartyCookiesboolean or null

Whether to block third-party cookies

Example: false
frequencystring

Frequency options for web journey execution

Enum"paused""once""15 minutes""1 hour""6 hours""12 hours""daily""weekly""biweekly""monthly"
Example: "daily"
locationstring or null

Geographic location for the web journey execution

Example: "US-West"
userAgentstring or null

User agent string to use

Example: "Chrome/91.0.4472.124"
userAgentDescriptionstring or null

Human-readable description of the user agent

Example: "Chrome Browser"
customProxystring or null

Custom proxy server configuration

Example: "proxy.example.com:8080"
monitoredByScriptServicesboolean or null

Whether this journey is monitored by script services

Example: true
createdAtstring(date-time)

When the web journey was created

Example: "2023-06-01T10:30:00Z"
nextCheckstring or null(date-time)

When the next execution is scheduled

Example: "2023-06-02T10:30:00Z"
scheduleobject
Response
application/json
{
  "id": 12345,
  "name": "E-commerce Checkout Flow",
  "notes": "Tests the complete checkout process",
  "domainId": 123,
  "userId": 456,
  "folderId": 789,
  "browserWidth": 1920,
  "browserHeight": 1080,
  "loadVideos": true,
  "vpnEnabled": false,
  "gpcEnabled": true,
  "blockThirdPartyCookies": false,
  "frequency": "daily",
  "location": "US-West",
  "userAgent": "Chrome/91.0.4472.124",
  "userAgentDescription": "Chrome Browser",
  "customProxy": "proxy.example.com:8080",
  "monitoredByScriptServices": true,
  "createdAt": "2023-06-01T10:30:00Z",
  "nextCheck": "2023-06-02T10:30:00Z",
  "schedule": {
    "dtStart": "string",
    "tzId": "string",
    "recurrenceRule": "string",
    "isPaused": true,
    "description": "string",
    "presetType": "12_HOUR"
  }
}