Skip to content
v2 API/
/
Create a manual journey r...

V2 API

Download OpenAPI description
SCALA-API.openapi.json
SCALA-API.openapi.yaml
Languages
Servers
https://api.observepoint.com/v2/

Tags

Endpoints for managing tags and tag-related operations including tag metadata and configuration

Operations

Rules

Endpoints for managing rules including creation, configuration, assignment, and rule-based validation logic

Operations

Audits

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

Operations

Sub-Folders

Endpoints for managing sub-folders including creation, configuration, and sub-folder-based audit and journey management

Operations

Manual Journeys

Endpoints for managing manual journeys including real device testing, HAR file ingestion, and journey execution control. These endpoints power Live Connect and HAR Analyzer features in the ObservePoint UI, enabling users to perform manual testing on real devices and analyze HAR files for tag validation and troubleshooting.

For more information, see the HAR File Processing API Recipe.

Operations

Delete manual journey via POST request

Request

POST /v2/manual-journeys/{manualJourneyId}/delete

This endpoint provides the same functionality as DELETE /v2/manual-journeys/{manualJourneyId}. It exists to support browser sendBeacon() calls, which can only perform POST requests. This is used when users abruptly leave the live-connect page to ensure proper cleanup of the live-connect session (including stopping any ECS tasks associated with the run and removing the run from the database).

Security
API_Key
Path
manualJourneyIdinteger(int32)required
curl -i -X POST \
  'https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}/delete' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Item was successfully deleted

Response
No content

Create a manual journey run within the manualJourneyId based on uploaded har files.

Request

POST /v2/manual-journeys/{manualJourneyId}/har-runs
Security
API_Key
Path
manualJourneyIdinteger(int32)required
Bodyapplication/jsonrequired

New har manual journey request

harFilesArray of objectsrequired
harFiles[].​namestring
harFiles[].​s3Keystringrequired
journeyRunNamestring
webhookUrlstring
curl -i -X POST \
  'https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}/har-runs' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "harFiles": [
      {
        "name": "string",
        "s3Key": "string"
      }
    ],
    "journeyRunName": "string",
    "webhookUrl": "string"
  }'

Responses

successful operation

Bodyapplication/json
integer(int64)
Response
application/json
0

Get manual journey labels

Request

GET /v2/manual-journeys/{manualJourneyId}/labels
Security
API_Key
Path
manualJourneyIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}/labels' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
number
]
Response
application/json
[
  0
]

Account

Endpoints for managing account settings, configurations, and account-level information

Operations

Users

Endpoints for managing users including creation, authentication, permissions, and user account management

Operations

Labels

Endpoints for managing labels including creation, assignment, and retrieval for organizing audits, journeys, and other resources

Operations

Folders

Endpoints for managing folders including creation, organization, access control, and folder-based resource management

Operations