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.
v3 API//
- Get web journey action by ID
Get web journeys
Create web journey
Delete web journeys by domain or folder
Get web journey by ID
Update web journey
Delete web journey
Get web journey status
Get web journey actions
Update web journey actions
Update web journey action
Get web journey run status
Delete web journey run
Delete current web journey run
Get web journey notification configuration
Update web journey notification configuration
Get web journey rules
Update web journey rules
Get web journey action rules
Update web journey action rules
Get web journey remote file mappings
Update web journey remote file mappings
Get action requests
Get action logs
Get all labels attached to specified web journey
Patch labels attached to specified web journey
Get journey configuration info for specified journey run
Get web journey action by...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/jsonrequired
List of actions to update
Type of the user action
Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut
List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame
Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput
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
URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut
Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut
ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-journeys/{webJourneyId}/actions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://api.observepoint.com/v3/web-journeys/107239/actions \
-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"
}
]'Web journey actions updated successfully
Type of the user action
Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut
List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame
Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput
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
URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut
Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut
ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
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" } ]
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-journeys/{webJourneyId}/actions/{actionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/web-journeys/107239/actions/1001 \
-H 'Authorization: YOUR_API_KEY_HERE'Web journey action retrieved successfully
Type of the user action
Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut
List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame
Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput
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
URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut
Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut
ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
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" }
Bodyapplication/jsonrequired
Action data to update
Type of the user action
Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut
List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame
Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput
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
URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut
Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut
ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-journeys/{webJourneyId}/actions/{actionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Web journey action updated successfully
Type of the user action
Enum"click""input""maskedinput""select""check""uncheck""enteriframe""navto""watch""clearcookies"
Duration to wait in milliseconds. Present for actionTypes: navTo, click, input, select, check, uncheck, execute, watch, maskedInput, enterIFrame, exitIFrame, clearCookies, privacyOptIn, privacyOptOut
List of selectors for element-based actions. Present for actionTypes: click, input, select, check, uncheck, maskedInput, enterIFrame
Whether to prevent navigation after action execution. Present for actionTypes: click, input, select, check, uncheck, execute, watch, maskedInput
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
URL for navigation and privacy actions. Present for actionTypes: navTo, privacyOptIn, privacyOptOut
Whether privacy action is required. Present for actionTypes: privacyOptIn, privacyOptOut
ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
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" }