Skip to content
v2 API/
/
Stop and discard audit ru...

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 specified audit run

Request

GET /v2/web-audits/{webAuditId}/runs/{runId}
Security
API_Key
Path
webAuditIdinteger(int32)required
runIdinteger(int64)required
curl -i -X GET \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}/runs/{runId}' \
  -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 discard audit run

Request

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

Responses

Item was successfully deleted

Get rule results for page

Request

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

Responses

successful operation

Bodyapplication/json
resultsArray of objectsrequired
results[].​namestringrequired
results[].​noOfChecksobjectrequired
results[].​noOfChecks.​actualinteger(int32)required
results[].​noOfChecks.​expectedinteger(int32)required
results[].​pageFilterResultsArray of objectsrequired
results[].​pageFilterResults[].​actualstringrequired
results[].​pageFilterResults[].​expectedstringrequired
results[].​pageFilterResults[].​filterTypestring
Enum"Url""StatusCode""FinalUrl""FinalStatusCode"
results[].​pageFilterResults[].​matchTypestring
Enum"Equals""DoesNotEqual""Contains""DoesNotContain""Regex""IsSet""IsNotSet""GreaterThanOrEqualTo""LessThanOrEqualTo"
results[].​resultTypestring
Enum"Passed""Failed""NotApplied""Broken"
results[].​ruleIdinteger(int32)required
results[].​tagResultsArray of objectsrequired
results[].​tagResults[].​conditionIdinteger(int32)required
results[].​tagResults[].​resultTypestring
Enum"Passed""TagMissing""IncorrectVariables"
results[].​tagResults[].​tagobjectrequired
results[].​tagResults[].​tag.​idinteger(int32)required
results[].​tagResults[].​tag.​namestringrequired
results[].​tagResults[].​tag.​tagAccountstring
results[].​tagResults[].​tag.​tagAccountMatchTypestring
Enum"Equals""DoesNotEqual""Contains""DoesNotContain""Regex""IsSet""IsNotSet""GreaterThanOrEqualTo""LessThanOrEqualTo"
results[].​tagResults[].​tag.​variablesArray of objectsrequired
results[].​tagResults[].​tag.​variables[].​actualValuestring
results[].​tagResults[].​tag.​variables[].​expectedParamNamestring
results[].​tagResults[].​tag.​variables[].​expectedValuesArray of stringsuniquerequired
results[].​tagResults[].​tag.​variables[].​matchTypestring
Enum"Equals""DoesNotEqual""Contains""DoesNotContain""Regex""IsSet""IsNotSet""GreaterThanOrEqualTo""LessThanOrEqualTo"
results[].​tagResults[].​tag.​variables[].​namestring
results[].​tagResults[].​tag.​variables[].​resultTypestring
Enum"Passed""MissingVariable""BadValue"
results[].​tagResults[].​tag.​variables[].​selectorTypestring
Enum"String""UrlParameter""DataLayer""Tag""FinalUrlParameter"
results[].​tagResults[].​tag.​variables[].​snapshotIdinteger(int64)required
results[].​tagResults[].​tag.​variables[].​variableTagobject
summaryobjectrequired
summary.​totalNoOfRulesAppliedinteger(int32)required
summary.​totalNoOfRulesFailedinteger(int32)required
summary.​totalNoOfRulesNotAppliedinteger(int32)required
summary.​totalNoOfRulesPassedinteger(int32)required
Response
application/json
{
  "results": [
    { … }
  ],
  "summary": {
    "totalNoOfRulesApplied": 0,
    "totalNoOfRulesFailed": 0,
    "totalNoOfRulesNotApplied": 0,
    "totalNoOfRulesPassed": 0
  }
}

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