Get web journey status

v3 API/

Request

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

Retrieve the current status of a web journey

Security

API_Key

Path

webJourneyIdinteger, (int64)required

Unique identification number for web journey item

Example:107239

GET

/v3/web-journeys/{webJourneyId}/status

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

Responses

Web journey status retrieved successfully

Bodyapplication/json

statusstringrequired

Status of a web journey run

Enum:"NotChecked""Ok""Failure""PageFailure""ActionFailure""RulesFailure""ExecutingActions""ProcessingRules""DataCollectionFailure"

Example:"Ok"

webJourneyRunningbooleanrequired

Whether the web journey is currently running

Example:false

lastCheckstring or null, (date-time)

When the web journey was last executed

Example:"2023-06-01T16:45:00Z"

queuedbooleanrequired

Whether the web journey is queued for execution

Example:false

failureTypestring or null

The failure type of the last run, present only when status indicates failure

Enum:"JOURNEY_ACTION_FAIL""JOURNEY_COOKIE_COLLECTION_ERROR""JOURNEY_DATA_LAYER_COLLECTION_ERROR""JOURNEY_HAR_COLLECTION_ERROR""JOURNEY_SCREENSHOT_COLLECTION_ERROR""JOURNEY_DATA_COLLECTION_ERROR"

Response

{
  "status": "Ok",
  "webJourneyRunning": false,
  "lastCheck": "2023-06-01T16:45:00Z",
  "queued": false,
  "failureType": "JOURNEY_ACTION_FAIL"
}