Skip to content
v2 API/
/
Get manual journey

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

Get default certificate metadata

Request

GET /v2/manual-journeys/certificates/default
Security
API_Key
curl -i -X GET \
  https://api.observepoint.com/v2/manual-journeys/certificates/default \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
idstringrequired
namestringrequired
Response
application/json
{
  "id": "string",
  "name": "string"
}

Get manual journey

Request

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

Responses

successful operation

Bodyapplication/json
createdAtstring(date-time)required
emailsArray of stringsrequired
folderIdinteger(int32)required
idinteger(int32)required
journeyTypeinteger(int32)
labelsArray of objects
namestringrequired
osOfDevicestringrequired
updatedAtstring(date-time)required
userIdinteger(int32)required
versionOfOsstringrequired
Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "emails": [
    "string"
  ],
  "folderId": 0,
  "id": 0,
  "journeyType": 0,
  "labels": [
    { … }
  ],
  "name": "string",
  "osOfDevice": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": 0,
  "versionOfOs": "string"
}

Initialize manual journey run

Request

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

Responses

successful operation

Bodyapplication/json
certificateobject
journeyIdinteger(int32)required
namestringrequired
proxyInfoobjectrequired
proxyInfo.​authorizationobject
proxyInfo.​interfacestringrequired
proxyInfo.​portinteger(int32)required
runIdinteger(int32)required
Response
application/json
{
  "certificate": {
    "id": "string",
    "name": "string"
  },
  "journeyId": 0,
  "name": "string",
  "proxyInfo": {
    "authorization": { … },
    "interface": "string",
    "port": 0
  },
  "runId": 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