Skip to content
v3 API/
/
Get web journey run statu...

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

Update web journey action

Request

PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}

Update a specific action within a web journey

Security
API_Key
Path
webJourneyIdinteger(int64)required

Unique identification number for web journey item

Example: 107239
actionIdinteger(int64)required

The ID of the action

Example: 1001
Bodyapplication/jsonrequired

Action data to update

sequenceintegerrequired

Sequence number of the action

descriptionstring

Description of the action. Present for all actionTypes except: actionSet

actionTypestringrequired

Type of the user action

Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
waitDurationinteger

Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut

selectorsArray of objects

List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame

preventNavigationboolean

Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput

valuestring

Value field with different meanings per actionType. For input/select: input value. For navTo: URL. For privacyOptIn/privacyOptOut: URL. For execute: JavaScript code. Present for actionTypes: input, select, navTo, privacyOptIn, privacyOptOut, execute

maskedValuestring

Masked value for secure input actions. Present for actionType: maskedInput

jsstring

JavaScript code to execute. Present for actionType: execute

urlstring

URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut

secondsinteger

Number of seconds to watch/wait. Present for actionType: watch

isRequiredboolean

Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut

actionSetIdinteger(int64)

ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID

pageFilterstring

Page filter pattern for the action

curl -i -X PUT \
  https://api.observepoint.com/v3/web-journeys/107239/actions/1001 \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sequence": 0,
    "description": "string",
    "actionType": "click",
    "waitDuration": 0,
    "selectors": [
      {
        "selectorType": "id",
        "value": null
      }
    ],
    "preventNavigation": true,
    "value": "string",
    "maskedValue": "string",
    "js": "string",
    "url": "string",
    "seconds": 0,
    "isRequired": true,
    "actionSetId": 0,
    "pageFilter": "string"
  }'

Responses

Web journey action updated successfully

Bodyapplication/json
sequenceintegerrequired

Sequence number of the action

idinteger(int64)read-only

ID of the action

descriptionstring

Description of the action. Present for all actionTypes except: actionSet

actionTypestringrequired

Type of the user action

Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
waitDurationinteger

Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut

selectorsArray of objects

List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame

preventNavigationboolean

Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput

valuestring

Value field with different meanings per actionType. For input/select: input value. For navTo: URL. For privacyOptIn/privacyOptOut: URL. For execute: JavaScript code. Present for actionTypes: input, select, navTo, privacyOptIn, privacyOptOut, execute

maskedValuestring

Masked value for secure input actions. Present for actionType: maskedInput

jsstring

JavaScript code to execute. Present for actionType: execute

urlstring

URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut

secondsinteger

Number of seconds to watch/wait. Present for actionType: watch

isRequiredboolean

Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut

actionSetIdinteger(int64)

ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID

pageFilterstring

Page filter pattern for the action

Response
application/json
{
  "sequence": 0,
  "id": 0,
  "description": "string",
  "actionType": "click",
  "waitDuration": 0,
  "selectors": [
    { … }
  ],
  "preventNavigation": true,
  "value": "string",
  "maskedValue": "string",
  "js": "string",
  "url": "string",
  "seconds": 0,
  "isRequired": true,
  "actionSetId": 0,
  "pageFilter": "string"
}

Get web journey run status

Request

GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status

Retrieve the status of a specific web journey run

Security
API_Key
Path
webJourneyIdinteger(int64)required

Unique identification number for web journey item

Example: 107239
runIdinteger(int64)required

The ID of the web journey run

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

Responses

Web journey run status retrieved successfully

Bodyapplication/json
statusinteger

The numeric status value of the web journey run

Response
application/json
{
  "status": 0
}

Delete web journey run

Request

DELETE /v3/web-journeys/{webJourneyId}/runs/{runId}

Stop/discard a specific web journey run

Security
API_Key
Path
webJourneyIdinteger(int64)required

Unique identification number for web journey item

Example: 107239
runIdinteger(int64)required

The ID of the web journey run

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

Responses

Web journey run deleted successfully

Response
No content