Skip to content
v2 API/
/
Create new sub-folder

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

Get list of all sub-folders

Request

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

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
createdAtstring(date-time)required
domainstringrequired
folderIdinteger(int32)required
idinteger(int32)required
namestringrequired
totalsobject
userIdinteger(int32)required
]
Response
application/json
[
  {
    "accountId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "domain": "string",
    "folderId": 0,
    "id": 0,
    "name": "string",
    "totals": { … },
    "userId": 0
  }
]

Create new sub-folder

Request

POST /v2/domains
Security
API_Key
Bodyapplication/jsonrequired

New sub-folder info

dataLayerstring
domainstringrequired
folderIdinteger(int32)required
namestringrequired
curl -i -X POST \
  https://api.observepoint.com/v2/domains \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dataLayer": "string",
    "domain": "string",
    "folderId": 0,
    "name": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
createdAtstring(date-time)required
domainstringrequired
folderIdinteger(int32)required
idinteger(int32)required
namestringrequired
totalsobject
userIdinteger(int32)required
Response
application/json
{
  "accountId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "domain": "string",
  "folderId": 0,
  "id": 0,
  "name": "string",
  "totals": {
    "auditsRunning": 0,
    "automatedJourneys": 0,
    "averageScore": 0,
    "errors": 0,
    "guidedJourneys": 0,
    "pages": 0,
    "simulationsRunning": 0
  },
  "userId": 0
}

Get sub-folder by id

Request

GET /v2/domains/{domainId}
Security
API_Key
Path
domainIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/domains/{domainId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
createdAtstring(date-time)required
domainstringrequired
folderIdinteger(int32)required
idinteger(int32)required
namestringrequired
totalsobject
userIdinteger(int32)required
Response
application/json
{
  "accountId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "domain": "string",
  "folderId": 0,
  "id": 0,
  "name": "string",
  "totals": {
    "auditsRunning": 0,
    "automatedJourneys": 0,
    "averageScore": 0,
    "errors": 0,
    "guidedJourneys": 0,
    "pages": 0,
    "simulationsRunning": 0
  },
  "userId": 0
}

Update sub-folder with given id

Request

PUT /v2/domains/{domainId}
Security
API_Key
Path
domainIdinteger(int32)required
Bodyapplication/jsonrequired

Sub-folder update information

dataLayerstring
domainstringrequired
folderIdinteger(int32)required
namestringrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/domains/{domainId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dataLayer": "string",
    "domain": "string",
    "folderId": 0,
    "name": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
createdAtstring(date-time)required
domainstringrequired
folderIdinteger(int32)required
idinteger(int32)required
namestringrequired
totalsobject
userIdinteger(int32)required
Response
application/json
{
  "accountId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "domain": "string",
  "folderId": 0,
  "id": 0,
  "name": "string",
  "totals": {
    "auditsRunning": 0,
    "automatedJourneys": 0,
    "averageScore": 0,
    "errors": 0,
    "guidedJourneys": 0,
    "pages": 0,
    "simulationsRunning": 0
  },
  "userId": 0
}

Delete sub-folder with given id

Request

DELETE /v2/domains/{domainId}
Security
API_Key
Path
domainIdinteger(int32)required
curl -i -X DELETE \
  'https://api.observepoint.com/v2/domains/{domainId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Item was successfully deleted

Response
No content

Get web audits for sub-folder with given id

Request

GET /v2/domains/{domainId}/web-audits
Security
API_Key
Path
domainIdinteger(int32)required
Query
withRunsbooleanrequired
runsLimitstringrequired
curl -i -X GET \
  'https://api.observepoint.com/v2/domains/{domainId}/web-audits?withRuns=true&runsLimit=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
createdstring(date-time)required
domainIdinteger(int32)required
filtersobject
folderIdinteger(int32)required
frequencystring
idinteger(int32)required
labelsArray of objectsrequired
labels[].​idinteger(int32)required
labels[].​namestringrequired
lastRunstring(date-time)
lastUpdatedstring(date-time)required
limitinteger(int32)required
namestringrequired
nextRunstring(date-time)
optionsobject
ownerIdinteger(int32)required
queuedbooleanrequired
recipientsArray of stringsrequired
rulesArray of objects
runsArray of objectsrequired
runs[].​adobeAuditorbooleanrequired
runs[].​completedstring(date-time)
runs[].​idinteger(int32)required
runs[].​limitinteger(int32)required
runs[].​scoreinteger(int32)

Deprecated. Use /v3/web-audits/{auditId}/runs/{runId}/scores instead

runs[].​silentModebooleanrequired
runs[].​startedstring(date-time)
runs[].​supportedFeaturesArray of strings
Example: "[TagLoadtimeReport, ConsoleLogsReport]"
runs[].​taggedUrlinteger(int32)required
runs[].​totalUrlinteger(int32)required
runs[].​userIdinteger(int32)required
runs[].​webAuditIdinteger(int32)required
scheduleboolean
screenshotstring
startingUrlsArray of stringsrequired
taggingPlansArray of numbers
webAuditRunningnumber
]
Response
application/json
[
  {
    "created": "2019-08-24T14:15:22Z",
    "domainId": 0,
    "filters": { … },
    "folderId": 0,
    "frequency": "string",
    "id": 0,
    "labels": [ … ],
    "lastRun": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "limit": 0,
    "name": "string",
    "nextRun": "2019-08-24T14:15:22Z",
    "options": { … },
    "ownerId": 0,
    "queued": true,
    "recipients": [ … ],
    "rules": [ … ],
    "runs": [ … ],
    "schedule": true,
    "screenshot": "string",
    "startingUrls": [ … ],
    "taggingPlans": [ … ],
    "webAuditRunning": 0
  }
]

Get web journeys for sub-folder with given id

Request

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

Responses

successful operation

Bodyapplication/jsonArray [
actionsArray of objectsrequired
actions[].​actionstring
Enum"navto""click""input""select""check""uncheck""execute""watch""maskedInput""enterIframe"
actions[].​actionIdnumber
actions[].​jsstring
actions[].​labelstring
actions[].​maskedValuestring
actions[].​preventNavbooleanrequired
actions[].​rulesArray of numbers
actions[].​secondsinteger(int32)
actions[].​selectorsArray of objectsrequired
actions[].​selectors[].​selectorTypeinteger(int32)required
Discriminator
actions[].​selectors[].​valueobjectrequired
actions[].​selectors[].​value.​attributesArray of objectsrequired
actions[].​selectors[].​value.​attributes[].​namestringrequired
actions[].​selectors[].​value.​attributes[].​valuestring
actions[].​selectors[].​value.​innerHTMLstring
actions[].​selectors[].​value.​tagNamestring
actions[].​sequenceinteger(int32)required
actions[].​urlstring
actions[].​valuestring
actions[].​waitDurationinteger(int32)[ 0 .. 1800 ]
createdAtstring(date-time)
domainIdinteger(int64)required
emailsArray of stringsrequired
folderIdinteger(int64)required
idinteger(int64)required
lastCheckstring(date-time)
namestringrequired
nextCheckstring(date-time)
optionsobjectrequired
options.​alertsbooleanrequired
options.​browserWidthinteger(int32)required
options.​customProxystring
options.​flashLiveVideoEnabledboolean
options.​frequencystring
options.​loadFlashbooleanrequired
options.​locationstringrequired
options.​monitoredByScriptServicesnumber
options.​nextRunstring(date-time)
options.​remoteFileMapConfigArray of objects
options.​userAgentstringrequired
options.​userAgentDescriptionstring
options.​vpnEnabledboolean
options.​webHookUrlstring
queuedbooleanrequired
screenshotstring
statusstring
Enum"Ok""Failed""NotChecked""RulesFailed""ActionFailed""PageFailed"
userIdinteger(int64)required
webJourneyRunningboolean
]
Response
application/json
[
  {
    "actions": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "domainId": 0,
    "emails": [ … ],
    "folderId": 0,
    "id": 0,
    "lastCheck": "2019-08-24T14:15:22Z",
    "name": "string",
    "nextCheck": "2019-08-24T14:15:22Z",
    "options": { … },
    "queued": true,
    "screenshot": "string",
    "status": "Ok",
    "userId": 0,
    "webJourneyRunning": true
  }
]

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

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