ObservePoint

ObservePoint Web Journeys Management API

APIs for managing Web Journeys

GitHub OpenAPI

Operations 29

GET /v3/web-journeys Get web journeys #
POST /v3/web-journeys Create web journey #
DELETE /v3/web-journeys Delete web journeys by domain or folder #
GET /v3/web-journeys/{webJourneyId} Get web journey by ID #
PUT /v3/web-journeys/{webJourneyId} Update web journey #
DELETE /v3/web-journeys/{webJourneyId} Delete web journey #
PATCH /v3/web-journeys/undelete Undelete a web journey #
GET /v3/web-journeys/{webJourneyId}/status Get web journey status #
GET /v3/web-journeys/{webJourneyId}/actions Get web journey actions #
PUT /v3/web-journeys/{webJourneyId}/actions Update web journey actions #
GET /v3/web-journeys/{webJourneyId}/actions/{actionId} Get web journey action by ID #
PUT /v3/web-journeys/{webJourneyId}/actions/{actionId} Update web journey action #
GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status Get web journey run status #
DELETE /v3/web-journeys/{webJourneyId}/runs/{runId} Delete web journey run #
DELETE /v3/web-journeys/{webJourneyId}/runs/current Delete current web journey run #
GET /v3/web-journeys/{webJourneyId}/notificationconfig Get web journey notification configuration #
PUT /v3/web-journeys/{webJourneyId}/notificationconfig Update web journey notification configuration #
GET /v3/web-journeys/{webJourneyId}/rules Get web journey rules #
PUT /v3/web-journeys/{webJourneyId}/rules Update web journey rules #
GET /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules Get web journey action rules #
PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules Update web journey action rules #
GET /v3/web-journeys/{webJourneyId}/remotefilemappings Get web journey remote file mappings #
PUT /v3/web-journeys/{webJourneyId}/remotefilemappings Update web journey remote file mappings #
GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests Get action requests #
GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs Get action logs #
GET /v3/web-journeys/{webJourneyId}/labels Get all labels attached to specified web journey #
PATCH /v3/web-journeys/{webJourneyId}/labels Patch labels attached to specified web journey #
GET /v3/web-journeys/{webJourneyId}/runs/{runId}/info Get journey configuration info for specified journey run #
POST /v3/web-journeys/{webJourneyId}/runs Run web journey #

Documentation

📖
Documentation
https://api-docs.observepoint.com/sections/v3-index
📖
APIReference
https://api-docs.observepoint.com/openapi/combined.openapi
📖
Documentation
https://api-docs.observepoint.com/sections/grid-api-intro
📖
APIReference
https://api-docs.observepoint.com/openapi/grid-api.openapi
📖
Documentation
https://api-docs.observepoint.com/sections/v2-index
📖
APIReference
https://api-docs.observepoint.com/openapi/scala-api.openapi

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/observepoint/refs/heads/main/openapi/observepoint-web-journeys-management-api-openapi.yml

Other Resources

🔗
Examples
https://api-docs.observepoint.com/sections/grid-api-examples

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/observepoint-web-journeys-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

observepoint-web-journeys-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: V3 Web Journeys Management API
  description: 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.
  version: null
  contact:
    name: Observepoint
    url: https://www.observepoint.com/contact-us
servers:
- url: https://api.observepoint.com
  description: ObservePoint Production API
tags:
- name: web-journeys-management
  x-displayName: Web Journeys Management
  description: APIs for managing Web Journeys
paths:
  /v3/web-journeys:
    get:
      tags:
      - web-journeys-management
      summary: Get web journeys
      description: 'GET /v3/web-journeys


        Retrieve all web journeys with optional filtering'
      operationId: getWebJourneys
      parameters:
      - in: query
        name: domainId
        description: Filter by domain ID
        required: false
        schema:
          type: integer
          example: 123
      - in: query
        name: monitored
        description: Filter by monitored status
        required: false
        schema:
          type: boolean
          example: true
      - in: query
        name: accountId
        description: Filter by account ID
        required: false
        schema:
          type: integer
          example: 456
      responses:
        '200':
          description: List of web journeys retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebJourneyDTO'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - API_Key: []
    post:
      tags:
      - web-journeys-management
      summary: Create web journey
      description: 'POST /v3/web-journeys


        Create a new web journey'
      operationId: createWebJourney
      requestBody:
        description: Web journey data for creation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebJourneyUpdateDTO'
      responses:
        '200':
          description: Web journey created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyDTO'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - API_Key: []
    delete:
      tags:
      - web-journeys-management
      summary: Delete web journeys by domain or folder
      description: 'DELETE /v3/web-journeys


        Delete web journeys by domain ID or folder ID'
      operationId: deleteWebJourneys
      parameters:
      - in: query
        name: domainId
        description: Delete all web journeys in the specified domain
        required: false
        schema:
          type: integer
          example: 123
      - in: query
        name: folderId
        description: Delete all web journeys in the specified folder
        required: false
        schema:
          type: integer
          example: 456
      responses:
        '200':
          description: Web journeys deleted successfully
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get web journey by ID
      description: 'GET /v3/web-journeys/{webJourneyId}


        Retrieve a specific web journey by its ID'
      operationId: getWebJourney
      responses:
        '200':
          description: Web journey retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyDTO'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey
      description: 'PUT /v3/web-journeys/{webJourneyId}


        Update an existing web journey'
      operationId: updateWebJourney
      requestBody:
        description: Updated web journey data
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebJourneyUpdateDTO'
      responses:
        '200':
          description: Web journey updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyDTO'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    delete:
      tags:
      - web-journeys-management
      summary: Delete web journey
      description: 'DELETE /v3/web-journeys/{webJourneyId}


        Delete a specific web journey by its ID'
      operationId: deleteWebJourney
      responses:
        '200':
          description: Web journey deleted successfully
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/undelete:
    patch:
      tags:
      - web-journeys-management
      summary: Undelete a web journey
      description: 'PATCH /v3/web-journeys/undelete


        Restore a single archived web journey into a chosen destination Folder and Sub-folder. The original parents are not reinstated. Historical run data is not restored. Per-item outcomes (including destination_gone and already_restored) are returned in the 200 response body; only authentication and authorization failures use 401/403.'
      operationId: undeleteWebJourney
      requestBody:
        description: Web journey id and restore destination
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UndeleteWebJourneyRequest'
      responses:
        '200':
          description: Restore outcome for the requested web journey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UndeleteWebJourneyResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/status:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get web journey status
      description: 'GET /v3/web-journeys/{webJourneyId}/status


        Retrieve the current status of a web journey'
      operationId: getWebJourneyStatus
      responses:
        '200':
          description: Web journey status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyStatusDTO'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/actions:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get web journey actions
      description: 'GET /v3/web-journeys/{webJourneyId}/actions


        Retrieve all actions for a web journey'
      operationId: getWebJourneyActions
      responses:
        '200':
          description: Web journey actions retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActionSetActionDto'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey actions
      description: 'PUT /v3/web-journeys/{webJourneyId}/actions


        Update all actions for a web journey'
      operationId: updateWebJourneyActions
      requestBody:
        description: List of actions to update
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActionSetActionDto'
      responses:
        '200':
          description: Web journey actions updated successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActionSetActionDto'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/actions/{actionId}:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - in: path
      name: actionId
      description: The ID of the action
      required: true
      schema:
        type: integer
        format: int64
        example: 1001
    get:
      tags:
      - web-journeys-management
      summary: Get web journey action by ID
      description: 'GET /v3/web-journeys/{webJourneyId}/actions/{actionId}


        Retrieve a specific action by its ID within a web journey'
      operationId: getWebJourneyAction
      responses:
        '200':
          description: Web journey action retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionSetActionDto'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey action
      description: 'PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}


        Update a specific action within a web journey'
      operationId: updateWebJourneyAction
      requestBody:
        description: Action data to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionSetActionDto'
      responses:
        '200':
          description: Web journey action updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionSetActionDto'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/runs/{runId}/status:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - in: path
      name: runId
      description: The ID of the web journey run
      required: true
      schema:
        type: integer
        format: int64
        example: 12345
    get:
      tags:
      - web-journeys-management
      summary: Get web journey run status
      description: 'GET /v3/web-journeys/{webJourneyId}/runs/{runId}/status


        Retrieve the status of a specific web journey run'
      operationId: getWebJourneyRunStatus
      responses:
        '200':
          description: Web journey run status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRunStatusObject'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/runs/{runId}:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - in: path
      name: runId
      description: The ID of the web journey run
      required: true
      schema:
        type: integer
        format: int64
        example: 12345
    delete:
      tags:
      - web-journeys-management
      summary: Delete web journey run
      description: 'DELETE /v3/web-journeys/{webJourneyId}/runs/{runId}


        Stop/discard a specific web journey run'
      operationId: deleteWebJourneyRun
      responses:
        '204':
          description: Web journey run deleted successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/runs/current:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    delete:
      tags:
      - web-journeys-management
      summary: Delete current web journey run
      description: 'DELETE /v3/web-journeys/{webJourneyId}/runs/current


        Stop/discard the current web journey run'
      operationId: deleteCurrentWebJourneyRun
      responses:
        '204':
          description: Current web journey run deleted successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/notificationconfig:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get web journey notification configuration
      description: 'GET /v3/web-journeys/{webJourneyId}/notificationconfig


        Retrieve notification settings for a web journey'
      operationId: getWebJourneyNotificationConfig
      responses:
        '200':
          description: Notification configuration retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyNotificationConfig'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey notification configuration
      description: 'PUT /v3/web-journeys/{webJourneyId}/notificationconfig


        Update or create notification settings for a web journey'
      operationId: updateWebJourneyNotificationConfig
      requestBody:
        description: Notification configuration to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebJourneyNotificationConfig'
      responses:
        '200':
          description: Notification configuration updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyNotificationConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/rules:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get web journey rules
      description: 'GET /v3/web-journeys/{webJourneyId}/rules


        Retrieve all rules associated with a web journey'
      operationId: getWebJourneyRules
      responses:
        '200':
          description: Web journey rules retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyAndActionRules'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey rules
      description: 'PUT /v3/web-journeys/{webJourneyId}/rules


        Bind rules to a web journey and its actions'
      operationId: updateWebJourneyRules
      requestBody:
        description: Rules configuration to bind
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebJourneyAndActionRulesRequest'
      responses:
        '200':
          description: Web journey rules updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyAndActionRules'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - in: path
      name: actionId
      description: The ID of the action
      required: true
      schema:
        type: integer
        format: int64
        example: 1001
    get:
      tags:
      - web-journeys-management
      summary: Get web journey action rules
      description: 'GET /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules


        Retrieve rules for a specific action within a web journey'
      operationId: getWebJourneyActionRules
      responses:
        '200':
          description: Action rules retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Rule'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey action rules
      description: 'PUT /v3/web-journeys/{webJourneyId}/actions/{actionId}/rules


        Bind rules to a specific action within a web journey'
      operationId: updateWebJourneyActionRules
      requestBody:
        description: Set of rule IDs to bind to the action
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
              example:
              - 101
              - 102
              - 103
      responses:
        '200':
          description: Action rules updated successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Rule'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/remotefilemappings:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get web journey remote file mappings
      description: 'GET /v3/web-journeys/{webJourneyId}/remotefilemappings


        Retrieve all remote file mappings associated with a web journey'
      operationId: getWebJourneyRemoteFileMappings
      responses:
        '200':
          description: Remote file mappings retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RemoteFileMapping'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
    put:
      tags:
      - web-journeys-management
      summary: Update web journey remote file mappings
      description: 'PUT /v3/web-journeys/{webJourneyId}/remotefilemappings


        Bind remote file mappings to a web journey'
      operationId: updateWebJourneyRemoteFileMappings
      requestBody:
        description: Set of remote file mapping IDs to bind
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
                format: int64
              example:
              - 201
              - 202
              - 203
      responses:
        '200':
          description: Remote file mappings updated successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  type: integer
                  format: int64
                example:
                - 201
                - 202
                - 203
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - in: path
      name: runId
      description: The ID of the web journey run
      required: true
      schema:
        type: integer
        format: int64
        example: 12345
    - in: path
      name: actionSequenceId
      description: The sequence ID of the action
      required: true
      schema:
        type: integer
        format: int64
        example: 1
    get:
      tags:
      - web-journeys-management
      summary: Get action requests
      description: 'GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/requests


        Retrieve all network requests made during an action execution'
      operationId: getWebJourneyActionRequests
      responses:
        '200':
          description: Action requests retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebJourneyActionRequestResponse'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - in: path
      name: runId
      description: The ID of the web journey run
      required: true
      schema:
        type: integer
        format: int64
        example: 12345
    - in: path
      name: actionSequenceId
      description: The sequence ID of the action
      required: true
      schema:
        type: integer
        format: int64
        example: 1
    get:
      tags:
      - web-journeys-management
      summary: Get action logs
      description: 'GET /v3/web-journeys/{webJourneyId}/runs/{runId}/actions/{actionSequenceId}/logs


        Retrieve console logs generated during an action execution'
      operationId: getWebJourneyActionLogs
      responses:
        '200':
          description: Action logs retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConsoleLogDto'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
  /v3/web-journeys/{webJourneyId}/labels:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    get:
      tags:
      - web-journeys-management
      summary: Get all labels attached to specified web journey
      operationId: getWebJourneyAssignedLabels
      responses:
        '200':
          description: Successfully returned a list of web journey assigned labels.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelResponseDTO'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
      description: GET /v3/web-journeys/{webJourneyId}/labels
    patch:
      tags:
      - web-journeys-management
      summary: Patch labels attached to specified web journey
      operationId: patchWebJourneyAssignedLabels
      requestBody:
        description: Patch Document
        required: true
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AttachmentPatchDocument_RequestDTO'
      responses:
        '200':
          description: Successfully patched web journey assigned labels.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelResponseDTO'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
      description: PATCH /v3/web-journeys/{webJourneyId}/labels
  /v3/web-journeys/{webJourneyId}/runs/{runId}/info:
    parameters:
    - $ref: '#/components/parameters/WebJourneyId'
    - $ref: '#/components/parameters/RunId'
    get:
      tags:
      - web-journeys-management
      summary: Get journey configuration info for specified journey run
      operationId: getWebJourneyRunInfo
      responses:
        '200':
          description: Web Journey run configuration info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRun_ConfigurationInfoResponseDTO'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/UnAuthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - API_Key: []
      description: GET /v3/web-journeys/{webJourneyId}/runs/{runId}/info
  /v3/web-journeys/{webJourneyId}/runs:
    post:
      tags:
      - web-journeys-management
      summary: Run web journey
      description: 'POST /v3/web-journeys/{webJourneyId}/runs


        Creates a new run for the specified web journey.

        The journey must exist, have actions configured, and not already be running.'
      operationId: runWebJourney
      parameters:
      - $ref: '#/components/parameters/WebJourneyId'
      responses:
        '200':
          description: Run created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRun_CreatedResponseDTO'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRun_ErrorResponseDTO'
        '401':
          $ref: '#/components/responses/WebJourneyRun_UnAuthorized'
        '403':
          description: Usage limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRun_ErrorResponseDTO'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRun_ErrorResponseDTO'
        '409':
          description: Journey is already running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebJourneyRun_RunExistsResponseDTO'
              example:
                currentRunId: 5765431
                code: 33
      security:
      - API_Key: []
components:
  schemas:
    UndeleteWebJourneyResponse:
      type: object
      required:
      - id
      - status
      properties:
        id:
          type: integer
          format: int64
        status:
          $ref: '#/components/schemas/UndeleteStatus'
        folderId:
          type: integer
          format: int32
        subFolderId:
          type: integer
          format: int32
        code:
          $ref: '#/components/schemas/UndeleteFailureCode'
        reason:
          type: string
    HarPostData:
      type:
      - object
      - 'null'
      properties:
        mimeType:
          type: string
          format: mimeType
        params:
          type: array
          items:
            $ref: '#/components/schemas/HarPostParameter'
        text:
          type: string
        comment:
          $ref: '#/components/schemas/HarComment'
    TagProperties:
      type: object
      description: Tag information object containing category and tag details
      properties:
        tagCategoryId:
          type: integer
          description: Tag category ID
        tagCategoryName:
          type: string
          description: Tag category name
        tagId:
          type: integer
          description: Tag ID
        tagName:
          type: string
          description: Tag name
    PageFilter:
      type: object
      properties:
        id:
          type: integer
          format: int32
        ruleId:
          type: integer
          format: int32
        value:
          type: string
        type:
          $ref: '#/components/schemas/PageFilterTypeEnum'
        matchType:
          $ref: '#/components/schemas/MatchTypeEnum'
    ActionSetActionDto:
      allOf:
      - $ref: '#/components/schemas/SequencedAction'
      - type: object
        properties:
          actionSetId:
            type: integer
            format: int64
            description: ID of the action set this action belongs to. For actionType 'actionSet', this contains the referenced action set ID
          pageFilter:
            type: string
      

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/observepoint/refs/heads/main/openapi/observepoint-web-journeys-management-api-openapi.yml