# V2 API ## Servers ``` https://api.observepoint.com/v2 ``` ## Security ### API_Key [object Object],[object Object] Type: apiKey In: header Name: Authorization ## Download OpenAPI description - [V2 API](https://api-docs.observepoint.com/_bundle/openapi/SCALA-API.openapi.yaml) ## Account - [GET /account](https://api-docs.observepoint.com/openapi/scala-api.openapi/account/getaccount.md):
GET /v2/account
## Rules - [POST /rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/createrule.md):
POST /v2/rules
- [GET /rules/previews](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getrulepreviews.md):
GET /v2/rules/previews
- [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 /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 /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 /rules/snapshots/{ruleSnapshotId}/original](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getoriginalruleidfromsnapshot.md):
GET /v2/rules/snapshots/{ruleSnapshotId}/original
- [GET /rules/{ruleId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getrule.md):
GET /v2/rules/{ruleId}
- [PUT /rules/{ruleId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/updaterule.md):
PUT /v2/rules/{ruleId}
- [DELETE /rules/{ruleId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/deleterule.md):
DELETE /v2/rules/{ruleId}
- [GET /rules/{ruleId}/web-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/rules/getallwebjourneysbyrule.md):
GET /v2/rules/{ruleId}/web-journeys
## Tags - [GET /tags](https://api-docs.observepoint.com/openapi/scala-api.openapi/tags/getalltags.md):
GET /v2/tags
- [GET /tags/{tagId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/tags/gettag.md):
GET /v2/tags/{tagId}
## Users - [GET /users](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/getusers.md):
GET /v2/users
- [GET /users/{userId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/getuser.md):
GET /v2/users/{userId}
- [PUT /users/{userId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/updateuser.md):
PUT /v2/users/{userId}
- [DELETE /users/{userId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/deleteuser.md):
DELETE /v2/users/{userId}
- [GET /users/{userId}/folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/getuserfolders.md):
GET /v2/users/{userId}/folders
- [POST /users/{userId}/folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/adduserfolders.md):
POST /v2/users/{userId}/folders
- [PUT /users/{userId}/folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/users/setuserfolders.md):
PUT /v2/users/{userId}/folders
## Manual Journeys - [GET /manual-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/alljourneys.md):
GET /v2/manual-journeys
- [POST /manual-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/createjourney.md):
POST /v2/manual-journeys
- [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-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journey.md):
GET /v2/manual-journeys/{manualJourneyId}
- [POST /manual-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/initialize.md):
POST /v2/manual-journeys/{manualJourneyId}
- [PUT /manual-journeys/{manualJourneyId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/updatejourney.md):
PUT /v2/manual-journeys/{manualJourneyId}
- [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/{manualJ - [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 functio - [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-journeys/{manualJourneyId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journeylabels.md):
GET /v2/manual-journeys/{manualJourneyId}/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-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-journeys/{manualJourneyId}/rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/journeyrules.md):
GET /v2/manual-journeys/{manualJourneyId}/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 /manual-journeys/{manualJourneyId}/runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/manual-journeys/allruns.md):
GET /v2/manual-journeys/{manualJourneyId}/runs
- [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 /v2/manual-journeys/{manualJourneyId}/runs/{runId}POST /v2/manual-journeys/{manualJourneyId}/runs/{runId}/ - [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}/ac - [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}POST /v2/manual-journeys/{manualJourneyId}/runs/{runId}/ - [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}/la - [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}/la - [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}GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/re - [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}/re - [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}GET /v2/manual-journeys/{manualJourneyId}/runs/{runId}/re - [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}/ta ## Folders - [GET /folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/getfolders.md):
GET /v2/folders
- [POST /folders](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/createfolder.md):
POST /v2/folders
- [GET /folders/{folderId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/findfolder.md):
GET /v2/folders/{folderId}
- [PUT /folders/{folderId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/updatefolder.md):
PUT /v2/folders/{folderId}
- [DELETE /folders/{folderId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/deletefolder.md):
DELETE /v2/folders/{folderId}
- [GET /folders/{folderId}/users](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/getuserswithfolderid.md):
GET /v2/folders/{folderId}/users
- [POST /folders/{folderId}/users](https://api-docs.observepoint.com/openapi/scala-api.openapi/folders/addusers.md):
POST /v2/folders/{folderId}/users
## Sub-Folders - [GET /domains](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getdomains.md):
GET /v2/domains
- [POST /domains](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/createdomain.md):
POST /v2/domains
- [GET /domains/{domainId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getdomain.md):
GET /v2/domains/{domainId}
- [PUT /domains/{domainId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/updatedomain.md):
PUT /v2/domains/{domainId}
- [DELETE /domains/{domainId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/deletedomain.md):
DELETE /v2/domains/{domainId}
- [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 /domains/{domainId}/web-journeys](https://api-docs.observepoint.com/openapi/scala-api.openapi/sub-folders/getwebjourneys.md):
GET /v2/domains/{domainId}/web-journeys
## Audits - [GET /web-audits](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getallwebaudits.md):
GET /v2/web-audits
- [POST /web-audits](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/createwebaudit.md):
POST /v2/web-audits
- [GET /web-audits/frequencies](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditavailablefrequencies.md):
GET /v2/web-audits/frequencies
- [GET /web-audits/locations](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditavailablelocations.md):
GET /v2/web-audits/locations
- [GET /web-audits/user-agents](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditavailableuseragents.md):
GET /v2/web-audits/user-agents
- [GET /web-audits/{auditId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getauditlabels.md):
GET /v2/web-audits/{auditId}/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-audits/{auditId}/labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/deletewebauditlabels.md):
DELETE /v2/web-audits/{auditId}/labels
- [GET /web-audits/{webAuditId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebaudit.md):
GET /v2/web-audits/{webAuditId}
- [PUT /web-audits/{webAuditId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/updatewebaudit.md):
PUT /v2/web-audits/{webAuditId}
- [DELETE /web-audits/{webAuditId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/deletewebaudit.md):
DELETE /v2/web-audits/{webAuditId}
- [GET /web-audits/{webAuditId}/filters](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditfilters.md):
GET /v2/web-audits/{webAuditId}/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-audits/{webAuditId}/rules](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getwebauditrules.md):
GET /v2/web-audits/{webAuditId}/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 /web-audits/{webAuditId}/runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getruns.md):
GET /v2/web-audits/{webAuditId}/runs
- [POST /web-audits/{webAuditId}/runs](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/runauditnow.md):
POST /v2/web-audits/{webAuditId}/runs
- [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 /web-audits/{webAuditId}/runs/{runId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/audits/getrun.md):
GET /v2/web-audits/{webAuditId}/runs/{runId}
- [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 /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/GET /v2/labels
- [POST /labels](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/createnewlabel.md):
POST /v2/labels
- [PUT /labels/{labelId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/updatelabel.md):
PUT /v2/labels/{labelId}
- [DELETE /labels/{labelId}](https://api-docs.observepoint.com/openapi/scala-api.openapi/labels/deletealabel.md):
DELETE /v2/labels/{labelId}