Skip to content
v2 API/
/
Request audit run creatio...

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

Get all available audit runs

Request

GET /v2/web-audits/{webAuditId}/runs
Security
API_Key
Path
webAuditIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}/runs' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
adobeAuditorbooleanrequired
completedstring(date-time)
completedAtstring(date-time)
idinteger(int32)required
isRuleFailurePresentbooleanrequired
limitinteger(int32)required
scoreinteger(int32)required
silentModebooleanrequired
startedstring(date-time)required
supportedFeaturesArray of objectsrequired
supportedFeatures[].​valuestringrequired
taggedUrlinteger(int32)required
totalUrlinteger(int32)required
userIdinteger(int32)required
webAuditIdinteger(int32)required
]
Response
application/json
[
  {
    "adobeAuditor": true,
    "completed": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "id": 0,
    "isRuleFailurePresent": true,
    "limit": 0,
    "score": 0,
    "silentMode": true,
    "started": "2019-08-24T14:15:22Z",
    "supportedFeatures": [ … ],
    "taggedUrl": 0,
    "totalUrl": 0,
    "userId": 0,
    "webAuditId": 0
  }
]

Request audit run creation

Request

POST /v2/web-audits/{webAuditId}/runs
Security
API_Key
Path
webAuditIdinteger(int32)required
curl -i -X POST \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}/runs' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
adobeAuditorbooleanrequired
completedstring(date-time)
idinteger(int32)required
limitinteger(int32)required
scoreinteger(int32)

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

silentModebooleanrequired
startedstring(date-time)
supportedFeaturesArray of strings
Example: "[TagLoadtimeReport, ConsoleLogsReport]"
taggedUrlinteger(int32)required
totalUrlinteger(int32)required
userIdinteger(int32)required
webAuditIdinteger(int32)required
Response
application/json
{
  "adobeAuditor": true,
  "completed": "2019-08-24T14:15:22Z",
  "id": 0,
  "limit": 0,
  "score": 0,
  "silentMode": true,
  "started": "2019-08-24T14:15:22Z",
  "supportedFeatures": "[TagLoadtimeReport, ConsoleLogsReport]",
  "taggedUrl": 0,
  "totalUrl": 0,
  "userId": 0,
  "webAuditId": 0
}

Stop and finish the currently running audit

Request

POST /v2/web-audits/{webAuditId}/runs/current/finish
Security
API_Key
Path
webAuditIdinteger(int32)required
curl -i -X POST \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}/runs/current/finish' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit run successfully stopped and queued for summarization

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

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