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

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
GET
/v3/web-journeys/{webJourneyId}
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 or null
Response
{
  "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"
  }
}