How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ObservePoint

ObservePoint Web Journeys Management API

APIs for managing Web Journeys

Documentation Provider Profile APIs.io OpenAPI GitHub

ObservePoint Web Journeys Management API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include web-journeys-management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 29 operations across 18 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.observepoint.com.

29 operations 18 paths 68 schemas 4 DELETE14 GET2 PATCH2 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Contact
Observepoint
Resource Areas
1

Authentication & Security 1

ObservePoint Web Journeys Management API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key).

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 29

Across 18 paths, the API surfaces 29 operations — 4 DELETE, 14 GET, 2 PATCH, 2 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

web-journeys-management 29

APIs for managing Web Journeys

GET
/v3/web-journeys
Get web journeys
getWebJourneys 3 params → 200400401403
POST
/v3/web-journeys
Create web journey
createWebJourney body → 200400401403
DELETE
/v3/web-journeys
Delete web journeys by domain or folder
deleteWebJourneys 2 params → 200401403404
GET
/v3/web-journeys/{webJourneyId}
Get web journey by ID
getWebJourney 1 param → 200401403404
PUT
/v3/web-journeys/{webJourneyId}
Update web journey
updateWebJourney 1 param body → 200400401403404
DELETE
/v3/web-journeys/{webJourneyId}
Delete web journey
deleteWebJourney 1 param → 200401403404
PATCH
/v3/web-journeys/undelete
Undelete a web journey
undeleteWebJourney body → 200400401403
GET
/v3/web-journeys/{webJourneyId}/status
Get web journey status
getWebJourneyStatus 1 param → 200401403404
GET
/v3/web-journeys/{webJourneyId}/actions
Get web journey actions
getWebJourneyActions 1 param → 200401403404
PUT
/v3/web-journeys/{webJourneyId}/actions
Update web journey actions
updateWebJourneyActions 1 param body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/actions/{actionId}
Get web journey action by ID
getWebJourneyAction 2 params → 200401403404
PUT
/v3/web-journeys/{webJourneyId}/actions/{actionId}
Update web journey action
updateWebJourneyAction 2 params body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/runs/{runId}/status
Get web journey run status
getWebJourneyRunStatus 2 params → 200401403404
DELETE
/v3/web-journeys/{webJourneyId}/runs/{runId}
Delete web journey run
deleteWebJourneyRun 2 params → 204400401403404
DELETE
/v3/web-journeys/{webJourneyId}/runs/current
Delete current web journey run
deleteCurrentWebJourneyRun 1 param → 204400401403404
GET
/v3/web-journeys/{webJourneyId}/notificationconfig
Get web journey notification configuration
getWebJourneyNotificationConfig 1 param → 200401403404
PUT
/v3/web-journeys/{webJourneyId}/notificationconfig
Update web journey notification configuration
updateWebJourneyNotificationConfig 1 param body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/rules
Get web journey rules
getWebJourneyRules 1 param → 200401403404
PUT
/v3/web-journeys/{webJourneyId}/rules
Update web journey rules
updateWebJourneyRules 1 param body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules
Get web journey action rules
getWebJourneyActionRules 2 params → 200401403404
PUT
/v3/web-journeys/{webJourneyId}/actions/{actionId}/rules
Update web journey action rules
updateWebJourneyActionRules 2 params body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/remotefilemappings
Get web journey remote file mappings
getWebJourneyRemoteFileMappings 1 param → 200401403404
PUT
/v3/web-journeys/{webJourneyId}/remotefilemappings
Update web journey remote file mappings
updateWebJourneyRemoteFileMappings 1 param body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests
Get action requests
getWebJourneyActionRequests 3 params → 200401403404
GET
/v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs
Get action logs
getWebJourneyActionLogs 3 params → 200401403404
GET
/v3/web-journeys/{webJourneyId}/labels
Get all labels attached to specified web journey
getWebJourneyAssignedLabels 1 param → 200401403404
PATCH
/v3/web-journeys/{webJourneyId}/labels
Patch labels attached to specified web journey
patchWebJourneyAssignedLabels 1 param body → 200400401403404
GET
/v3/web-journeys/{webJourneyId}/runs/{runId}/info
Get journey configuration info for specified journey run
getWebJourneyRunInfo 2 params → 200400401403404
POST
/v3/web-journeys/{webJourneyId}/runs
Run web journey
runWebJourney 1 param → 200400401403404409

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are WebJourneyDTO (21 properties), WebJourneyUpdateDTO (19 properties), WebJourneyRun_ConfigurationInfoResponseDTO (14 properties), WebJourneyActionRequestResponse (14 properties). Each schema is shown below with its type and property counts.

Schedule
object
6 required
SelectorTypeEnum
string
MatchTypeEnum
stringnull
WebJourneyUpdateDTO
object
Web journey data for creation or update
19 properties 1 required
WebJourneyActionRulesRequest
object
2 properties
RemoteFileMappingFailure
object
2 properties 1 required
RequestBlocking
object
(Optional) Present if run configuration had TMS blocking enabled and request for this entry was blocked.
5 properties 2 required
CookieBase
object
11 properties 2 required
SequencedAction
object
13 properties 2 required
AttachmentPatchDocument_ItemDTO
object
A JSONPatch document for modifying consent preference attachments
3 properties
HarCacheEntry
objectnull
5 properties
RemoteFileMappingFailureType
integer
Substitution
object
4 properties 1 required
WebJourneyDTO
object
Web journey configuration and metadata
21 properties 4 required
WebJourneyAndActionRulesRequest
object
2 properties
HarResponse
object
11 properties
Label
object
DTO for Labels
2 properties 2 required
WebJourneyAndActionRules
object
2 properties
WebJourneyRunStatusEnum
string
Status of a web journey run
PageFilterTypeEnum
integernull
Type of the page filter.
CookiePartyType
string
Indicates if cookie domain is different from domain of a page it was set on. owned3rdparty is deprecated
Rule
object
13 properties
datetime
string
The full date and time, according to ISO-8601 (e. g. 2020-08-25T21:15:43Z)
HarComment
stringnull
LabelId
integer
Label identifier
ActionSetActionDto
WebJourneyRun_ErrorResponseDTO
object
2 properties 2 required
WebJourneyRun_CreatedResponseDTO
object
Response when a run is successfully created
1 property 1 required
UndeleteFailureCode
string
BaseScheduleForCreation
object
4 properties 4 required
WebJourneyRun_RunExistsResponseDTO
object
Response when a journey is already running
2 properties 2 required
LocationData
object
1 property 1 required
RuleTag
object
8 properties
HarRequest
object
12 properties
AttachmentPatchDocument_RequestDTO
array
HarCache
objectnull
3 properties
WebJourneyStatusDTO
object
Current status of a web journey
5 properties 3 required
ConsoleLogDto
object
5 properties
CookieSameSite
stringnull
RemoteFileMapping
object
Remote file mapping configuration
11 properties 9 required
nullableDatetime
stringnull
The full date and time, according to ISO-8601 (e. g. 2020-08-25T21:15:43Z)
WebJourneyId
integer
UndeleteStatus
string
WebJourneyRun_ConfigurationInfoResponseDTO
object
14 properties 13 required
LabelResponseDTO
object
DTO for get/patch labels
1 property
RunId
integer
WebJourneyRunStatusObject
object
1 property
HarResponseContent
object
6 properties
WebActionSelectorType
string
ClauseEnum
stringnull
HarHeaderOrQueryString
object
3 properties
HarPostData
objectnull
4 properties
WebJourneyActionRules
object
2 properties
WebJourneyRun_ErrorCode
integer
Error codes: - 10: ValidationError - 11: MalformedRequest - 33: AlreadyRunning - 34: UsageLimitExceeded
ErrorModel
object
4 properties
HarPostParameter
object
5 properties
WebJourneyFrequencyEnum
string
Frequency options for web journey execution
TagProperties
object
Tag information object containing category and tag details
4 properties
WebActionSelector
object
2 properties 2 required
HarCookie
PageFilter
object
5 properties
RuleTagVariable
object
8 properties
WebJourneyNotificationConfig
object
3 properties
HarEntryTimings
object
8 properties
UndeleteWebJourneyRequest
object
3 properties 3 required
UndeleteWebJourneyResponse
object
6 properties 2 required
WebJourneyActionRequestResponse
object
14 properties
WebJourneyFailureTypeEnum
string
Type of failure for a web journey run

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-web-journeys-management-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
AE Profile APIs.io
ObservePoint Account Triggered Alerts API
AE Profile APIs.io
ObservePoint Account Usage Alerts API
AE Profile APIs.io
ObservePoint Account Usage Export API
AE Profile APIs.io
ObservePoint Account Usage V2 API
AE Profile APIs.io
ObservePoint Action Set Action Rules API
AE Profile APIs.io
ObservePoint Action Set Actions API
AE Profile APIs.io
ObservePoint Action Sets API
AE Profile APIs.io
ObservePoint Alert Export API
AE Profile APIs.io
ObservePoint Alert Summary Report API
AE Profile APIs.io
ObservePoint Alerts API
AE Profile APIs.io
ObservePoint Audit Actions API
AE Profile APIs.io
#web-journeys-management
← Back to O APIs
API Details
ID
observepoint:observepoint-web-journeys-management-api
Base URL
https://api.observepoint.com
Docs
https://api-docs.observepoint.com/sections/v3-index
Provider
ObservePoint
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=observepoint-web-journeys-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/observepoint-web-journeys-management-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ObservePoint Web Journeys Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.