# V2 API


## Servers

```
https://api.observepoint.com/v2
```

## Security

### API_Key

Use the `Authorization` header in your requests with ObservePoint API key as header value.

Example: `Authorization: abc123...def456`

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[V2 API](https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml)

## Tags

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

### Returns all tags

 - [GET /tags](https://api-docs.observepoint.com/openapi/scala-api.openapi/tags/getalltags.md): GET /v2/tags

### Return tag by tagId

 - [GET /tags/{tagId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/tags/gettag.md): GET /v2/tags/{tagId}

## Rules

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

### Create new rule

 - [POST /rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/createrule.md): POST /v2/rules

### Get list of rule preview objects

 - [GET /rules/previews](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getrulepreviews.md): GET /v2/rules/previews

### Get original rule page filter id by given rule page filter snapshot id

 - [GET /rules/snapshots/page-filters/{pageFilterSnapshotId}/original](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getoriginalrulepagefilteridfromsnapshot.md): GET /v2/rules/snapshots/page-filters/{pageFilterSnapshotId}/original

### Get original rule tag variable id by given rule tag variable snapshot id

 - [GET /rules/snapshots/tags/variables/{tagVariableSnapshotId}/original](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getoriginalruletagvariableidfromsnapshot.md): GET /v2/rules/snapshots/tags/variables/{tagVariableSnapshotId}/original

### Get original rule tag id by given rule tag snapshot id

 - [GET /rules/snapshots/tags/{tagSnapshotId}/original](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getoriginalruletagidfromsnapshot.md): GET /v2/rules/snapshots/tags/{tagSnapshotId}/original

### Get original rule id by given rule snapshot id

 - [GET /rules/snapshots/{ruleSnapshotId}/original](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getoriginalruleidfromsnapshot.md): GET /v2/rules/snapshots/{ruleSnapshotId}/original

### Get rule by given id

 - [GET /rules/{ruleId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getrule.md): GET /v2/rules/{ruleId}

### Update rule with given id

 - [PUT /rules/{ruleId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/updaterule.md): PUT /v2/rules/{ruleId}

### Delete rule with given id

 - [DELETE /rules/{ruleId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/deleterule.md): DELETE /v2/rules/{ruleId}

### Get all web journeys with given rule id

 - [GET /rules/{ruleId}/web-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getallwebjourneysbyrule.md): GET /v2/rules/{ruleId}/web-journeys

## Audits

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

### Get list of all web audits

 - [GET /web-audits](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getallwebaudits.md): GET /v2/web-audits

### Create new web audit

 - [POST /web-audits](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/createwebaudit.md): POST /v2/web-audits

### Get list of all frequencies

 - [GET /web-audits/frequencies](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditavailablefrequencies.md): GET /v2/web-audits/frequencies

### Get list of all available locations

 - [GET /web-audits/locations](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditavailablelocations.md): GET /v2/web-audits/locations

### Get list of all available user agents

 - [GET /web-audits/user-agents](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditavailableuseragents.md): GET /v2/web-audits/user-agents

### Get audit labels

 - [GET /web-audits/{auditId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getauditlabels.md): GET /v2/web-audits/{auditId}/labels

### Create audit labels

 - [PUT /web-audits/{auditId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/createauditlabels.md): PUT /v2/web-audits/{auditId}/labels

### Delete web audit labels

 - [DELETE /web-audits/{auditId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/deletewebauditlabels.md): DELETE /v2/web-audits/{auditId}/labels

### Get web audit

 - [GET /web-audits/{webAuditId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebaudit.md): GET /v2/web-audits/{webAuditId}

### Update web audit

 - [PUT /web-audits/{webAuditId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/updatewebaudit.md): PUT /v2/web-audits/{webAuditId}

### Delete web audit

 - [DELETE /web-audits/{webAuditId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/deletewebaudit.md): DELETE /v2/web-audits/{webAuditId}

### Get web audit filters

 - [GET /web-audits/{webAuditId}/filters](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditfilters.md): GET /v2/web-audits/{webAuditId}/filters

### Update web audit filters

 - [PUT /web-audits/{webAuditId}/filters](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/updatewebauditfilters.md): PUT /v2/web-audits/{webAuditId}/filters

### Get web audit rules

 - [GET /web-audits/{webAuditId}/rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditrules.md): GET /v2/web-audits/{webAuditId}/rules

### Update web audit rules

 - [PUT /web-audits/{webAuditId}/rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/updatewebauditrules.md): PUT /v2/web-audits/{webAuditId}/rules

### Get all available audit runs

 - [GET /web-audits/{webAuditId}/runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getruns.md): GET /v2/web-audits/{webAuditId}/runs

### Request audit run creation

 - [POST /web-audits/{webAuditId}/runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/runauditnow.md): POST /v2/web-audits/{webAuditId}/runs

### Stop and finish the currently running audit

 - [POST /web-audits/{webAuditId}/runs/current/finish](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/finishactiveauditrun.md): POST /v2/web-audits/{webAuditId}/runs/current/finish

### Get specified audit run

 - [GET /web-audits/{webAuditId}/runs/{runId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getrun.md): GET /v2/web-audits/{webAuditId}/runs/{runId}

### Stop and discard audit run

 - [DELETE /web-audits/{webAuditId}/runs/{runId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/stopauditrun.md): DELETE /v2/web-audits/{webAuditId}/runs/{runId}

### Get rule results for page

 - [GET /web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getpageruleresults.md): GET /v2/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results

## Sub-Folders

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

### Get list of all sub-folders

 - [GET /domains](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getdomains.md): GET /v2/domains

### Create new sub-folder

 - [POST /domains](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/createdomain.md): POST /v2/domains

### Get sub-folder by id

 - [GET /domains/{domainId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getdomain.md): GET /v2/domains/{domainId}

### Update sub-folder with given id

 - [PUT /domains/{domainId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/updatedomain.md): PUT /v2/domains/{domainId}

### Delete sub-folder with given id

 - [DELETE /domains/{domainId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/deletedomain.md): DELETE /v2/domains/{domainId}

### Get web audits for sub-folder with given id

 - [GET /domains/{domainId}/web-audits](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getaudits.md): GET /v2/domains/{domainId}/web-audits

### Get web journeys for sub-folder with given id

 - [GET /domains/{domainId}/web-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getwebjourneys.md): GET /v2/domains/{domainId}/web-journeys

## 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](/sections/api-recipes/har-file-processing).

### Get all manual journeys

 - [GET /manual-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/alljourneys.md): GET /v2/manual-journeys

### Create new manual journey

 - [POST /manual-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/createjourney.md): POST /v2/manual-journeys

### Get default certificate metadata

 - [GET /manual-journeys/certificates/default](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/observepoint$api$manualjourney$manualjourneyroute$$getdefaultcertificate.md): GET /v2/manual-journeys/certificates/default

### Get manual journey

 - [GET /manual-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journey.md): GET /v2/manual-journeys/{manualJourneyId}

### Initialize manual journey run

 - [POST /manual-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/initialize.md): POST /v2/manual-journeys/{manualJourneyId}

### Update manual journey

 - [PUT /manual-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/updatejourney.md): PUT /v2/manual-journeys/{manualJourneyId}

### Delete manual journey

 - [DELETE /manual-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/deletejourney.md): DELETE /v2/manual-journeys/{manualJourneyId}

See also POST /v2/manual-journeys/{manualJourneyId}/delete for an equivalent endpoint that supports browser sendBeacon() calls.

### Delete manual journey via POST request

 - [POST /manual-journeys/{manualJourneyId}/delete](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/deletejourneyviapost.md): 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).

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

 - [POST /manual-journeys/{manualJourneyId}/har-runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/createharrun.md): POST /v2/manual-journeys/{manualJourneyId}/har-runs

### Get manual journey labels

 - [GET /manual-journeys/{manualJourneyId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journeylabels.md): GET /v2/manual-journeys/{manualJourneyId}/labels

### Update manual journey labels

 - [PUT /manual-journeys/{manualJourneyId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/updatejourneylabels.md): PUT /v2/manual-journeys/{manualJourneyId}/labels

### Delete manual journey label

 - [DELETE /manual-journeys/{manualJourneyId}/labels/{labelId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/deletejourneylabel.md): DELETE /v2/manual-journeys/{manualJourneyId}/labels/{labelId}

### Get manual journey rules

 - [GET /manual-journeys/{manualJourneyId}/rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journeyrules.md): GET /v2/manual-journeys/{manualJourneyId}/rules

### Update manual journey rules

 - [PUT /manual-journeys/{manualJourneyId}/rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/updatejourneyrules.md): PUT /v2/manual-journeys/{manualJourneyId}/rules

### Get all available manual journey runs

 - [GET /manual-journeys/{manualJourneyId}/runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/allruns.md): GET /v2/manual-journeys/{manualJourneyId}/runs

### Get specified manual journey run

 - [GET /manual-journeys/{manualJourneyId}/runs/{runId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/run.md): GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}

### Delete manual journey run

 - [DELETE /manual-journeys/{manualJourneyId}/runs/{runId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/deletejourneyrun.md): DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}

### Create new action in specified manual journey run

 - [POST /manual-journeys/{manualJourneyId}/runs/{runId}/actions](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/nextjourneyrunaction.md): POST /v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions

### Get specified manual journey run action

 - [GET /manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journeyrunaction.md): GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}

### Deletes specified manual journey run action

 - [DELETE /manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/deletejourneyrunaction.md): DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}/actions/{actionId}

### Manual journey run control request

 - [POST /manual-journeys/{manualJourneyId}/runs/{runId}/control](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/processruncontrolrequest.md): POST /v2/manual-journeys/{manualJourneyId}/runs/{runId}/control

### Get manual journey run labels

 - [GET /manual-journeys/{manualJourneyId}/runs/{runId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/runlabels.md): GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/labels

### Update manual journey run labels

 - [PUT /manual-journeys/{manualJourneyId}/runs/{runId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/updaterunlabels.md): PUT /v2/manual-journeys/{manualJourneyId}/runs/{runId}/labels

### Delete manual journey run label

 - [DELETE /manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/deleterunlabel.md): DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}/labels/{labelId}

### Get request filters of specified manual journey run

 - [GET /manual-journeys/{manualJourneyId}/runs/{runId}/request-filters](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/getrequestfilters.md): GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters

### Set request filters for specified manual journey run

 - [PUT /manual-journeys/{manualJourneyId}/runs/{runId}/request-filters](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/setrequestfilters.md): PUT /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters

### Reset request filters for specified manual journey run

 - [DELETE /manual-journeys/{manualJourneyId}/runs/{runId}/request-filters](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/removerequestfilters.md): DELETE /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-filters

### Get request logs of specified manual journey run

 - [GET /manual-journeys/{manualJourneyId}/runs/{runId}/request-logs](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/getrequestlogs.md): GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/request-logs

### Get tags of specified manual journey run

 - [GET /manual-journeys/{manualJourneyId}/runs/{runId}/tags](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/getruntags.md): GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/tags

## Account

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

### Returns account for current user

 - [GET /account](https://api-docs.observepoint.com/openapi/scala-api.openapi/account/getaccount.md): GET /v2/account

## Users

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

### Return all users for current user account.

 - [GET /users](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/getusers.md): GET /v2/users

### Create new user.Accessible only for admin users

 - [POST /users](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/createuserhandler.md): POST /v2/users

### Return user data by given id. Accessible only for admin users or if {userId} equal to current user id

 - [GET /users/{userId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/getuser.md): GET /v2/users/{userId}

### Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id

 - [PUT /users/{userId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/updateuser.md): PUT /v2/users/{userId}

### Delete user by given id. Accessible only for admin users

 - [DELETE /users/{userId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/deleteuser.md): DELETE /v2/users/{userId}

### Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id

 - [GET /users/{userId}/folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/getuserfolders.md): GET /v2/users/{userId}/folders

### Add given folders as shared for user with given userId.Accessible only for admin users

 - [POST /users/{userId}/folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/adduserfolders.md): POST /v2/users/{userId}/folders

### Set given folders as shared for user with given userId. Accessible only for admin users

 - [PUT /users/{userId}/folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/setuserfolders.md): PUT /v2/users/{userId}/folders

## Labels

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

### Get list of all labels

 - [GET /labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/getlabels.md): GET /v2/labels

### Create new label

 - [POST /labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/createnewlabel.md): POST /v2/labels

### Update existing label name

 - [PUT /labels/{labelId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/updatelabel.md): PUT /v2/labels/{labelId}

### Delete label with given id

 - [DELETE /labels/{labelId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/deletealabel.md): DELETE /v2/labels/{labelId}

## Folders

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

### Get list of all folders

 - [GET /folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/getfolders.md): GET /v2/folders

### Create new folder

 - [POST /folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/createfolder.md): POST /v2/folders

### Get folder by given id

 - [GET /folders/{folderId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/findfolder.md): GET /v2/folders/{folderId}

### Update folder with given id

 - [PUT /folders/{folderId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/updatefolder.md): PUT /v2/folders/{folderId}

### Delete folder with given id

 - [DELETE /folders/{folderId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/deletefolder.md): DELETE /v2/folders/{folderId}

### Get users of folder with given id

 - [GET /folders/{folderId}/users](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/getuserswithfolderid.md): GET /v2/folders/{folderId}/users

### Add users to folder with given id

 - [POST /folders/{folderId}/users](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/addusers.md): POST /v2/folders/{folderId}/users