Skip to content

V2 API

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

Set request filters for specified manual journey run

Request

PUT /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters
Security
API_Key
Path
manualJourneyIdinteger(int32)required
runIdinteger(int32)required
Bodyapplication/json
emptybooleanrequired
traversableAgainbooleanrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "empty": true,
    "traversableAgain": true
  }'

Responses

successful operation

Bodyapplication/jsonArray [
string
]
Response
application/json
[ "string" ]

Reset request filters for specified manual journey run

Request

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

Responses

successful operation

Bodyapplication/json
object
Response
application/json
{}

Get request logs of specified manual journey run

Request

GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs
Security
API_Key
Path
manualJourneyIdinteger(int32)required
runIdinteger(int32)required
Bodyapplication/json
limitinteger(int32)required
offsetinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 0,
    "offset": 0
  }'

Responses

successful operation

Bodyapplication/jsonArray [
enabledSslbooleanrequired
idstringrequired
journeyTagIdsArray of stringsrequired
requestInfoArray of objectsrequired
requestInfo[].​propNamestringrequired
requestInfo[].​propValuestringrequired
requestLogstringrequired
responseInfoArray of objectsrequired
responseInfo[].​propNamestringrequired
responseInfo[].​propValuestringrequired
stepIdinteger(int32)required
timestampinteger(int64)required
]
Response
application/json
[ { "enabledSsl": true, "id": "string", "journeyTagIds": [ … ], "requestInfo": [ … ], "requestLog": "string", "responseInfo": [ … ], "stepId": 0, "timestamp": 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