Skip to content
v3 API/
/
Get web journey action by...

Get web journey action by ID

Request

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

Retrieve a specific action by its ID 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
GET
/v3/web-journeys/{webJourneyId}/actions/{actionId}
curl -i -X GET \
  https://api.observepoint.com/v3/web-journeys/107239/actions/1001 \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Web journey action retrieved 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
{
  "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"
}