Skip to content
v2 API/
/
Get audit labels

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 list of all available user agents

Request

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

Responses

successful operation

Bodyapplication/jsonArray [
labelstringrequired
namestringrequired
]
Response
application/json
[
  {
    "label": "string",
    "name": "string"
  }
]

Get audit labels

Request

GET /v2/web-audits/{auditId}/labels
Security
API_Key
Path
auditIdinteger(int32)required
Bodyapplication/json
accountIdinteger(int32)required
accountStatusstringrequired
Enum"ACTIVE""ACTIVE_BILLING_PROBLEM""INACTIVE_BILLING_FAILED""INACTIVE_USER_CANCELLED""INACTIVE""DEMO"
accountTypestringrequired
Enum"ADOBE_AUDITOR""FREE""CONTRACT""CPM_PARTNER""SAMPLE""INTERNAL""CONTRACT_SELF_SERVICE"
authTokenobject
capabilitiesobjectrequired
capabilities.​customProxySupportbooleanrequired
capabilities.​strongPasswordPolicybooleanrequired
capabilities.​vpnSupportbooleanrequired
credsExpiredbooleanrequired
emailstringrequired
featuresArray of objectsrequired
idinteger(int32)required
isAccountActivebooleanrequired
isAccountAdminbooleanrequired
isLongTermTokenbooleanrequired
isOpAdminbooleanrequired
isOpSysAdminbooleanrequired
isReadOnlybooleanrequired
isUserbooleanrequired
isUserTokenbooleanrequired
isVisitorbooleanrequired
loginAsRequestedByUserIdnumber
permissionsobjectrequired
permissions.​intValueinteger(int32)required
permissions.​stringValuestringrequired
snowflakeUsageobjectrequired
snowflakeUsage.​useForAdobeAuditorbooleanrequired
snowflakeUsage.​useForAppJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForAppJourneysbooleanrequired
snowflakeUsage.​useForAuditsbooleanrequired
snowflakeUsage.​useForLiveConnectbooleanrequired
snowflakeUsage.​useForLiveConnectRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneyRuleResultsbooleanrequired
snowflakeUsage.​useForWebJourneysbooleanrequired
snowflakeUsage.​usedbooleanrequired
timezoneobjectrequired
timezone.​fixedbooleanrequired
timezone.​idstringrequired
tokenTypeobjectrequired
curl -i -X GET \
  'https://api.observepoint.com/v2/web-audits/{auditId}/labels' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 0,
    "accountStatus": "ACTIVE",
    "accountType": "ADOBE_AUDITOR",
    "authToken": {
      "created": "string",
      "decryptedToken": "string",
      "token": "string",
      "tokenType": {},
      "userId": "string"
    },
    "capabilities": {
      "customProxySupport": true,
      "strongPasswordPolicy": true,
      "vpnSupport": true
    },
    "credsExpired": true,
    "email": "string",
    "features": [
      {}
    ],
    "id": 0,
    "isAccountActive": true,
    "isAccountAdmin": true,
    "isLongTermToken": true,
    "isOpAdmin": true,
    "isOpSysAdmin": true,
    "isReadOnly": true,
    "isUser": true,
    "isUserToken": true,
    "isVisitor": true,
    "loginAsRequestedByUserId": 0,
    "permissions": {
      "intValue": 0,
      "stringValue": "string"
    },
    "snowflakeUsage": {
      "useForAdobeAuditor": true,
      "useForAppJourneyRuleResults": true,
      "useForAppJourneys": true,
      "useForAudits": true,
      "useForLiveConnect": true,
      "useForLiveConnectRuleResults": true,
      "useForWebJourneyRuleResults": true,
      "useForWebJourneys": true,
      "used": true
    },
    "timezone": {
      "fixed": true,
      "id": "string"
    },
    "tokenType": {}
  }'

Responses

successful operation

Bodyapplication/json
idinteger(int32)required
namestringrequired
Response
application/json
{
  "id": 0,
  "name": "string"
}

Create audit labels

Request

PUT /v2/web-audits/{auditId}/labels
Security
API_Key
Path
auditIdinteger(int32)required
Bodyapplication/json
emptybooleanrequired
traversableAgainbooleanrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/web-audits/{auditId}/labels' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "empty": true,
    "traversableAgain": true
  }'

Responses

successful operation

Bodyapplication/json
idinteger(int32)required
namestringrequired
Response
application/json
{
  "id": 0,
  "name": "string"
}

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