Skip to content
v2 API/
/
Update web audit filters

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 web audit filters

Request

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

Responses

successful operation

Bodyapplication/json
excludeArray of stringsrequired
includeArray of objectsrequired
include[].​includeLimitinteger(int32)required
include[].​valuestringrequired
Response
application/json
{
  "exclude": [
    "string"
  ],
  "include": [
    { … }
  ]
}

Update web audit filters

Request

PUT /v2/web-audits/{webAuditId}/filters
Security
API_Key
Path
webAuditIdinteger(int32)required
Bodyapplication/jsonrequired

New web audit filters

excludeArray of stringsrequired
includeArray of objectsrequired
include[].​includeLimitinteger(int32)required
include[].​valuestringrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}/filters' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "exclude": [
      "string"
    ],
    "include": [
      {
        "includeLimit": 0,
        "value": "string"
      }
    ]
  }'

Responses

successful operation

Bodyapplication/json
excludeArray of stringsrequired
includeArray of objectsrequired
include[].​includeLimitinteger(int32)required
include[].​valuestringrequired
Response
application/json
{
  "exclude": [
    "string"
  ],
  "include": [
    { … }
  ]
}

Get web audit rules

Request

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

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
checkTimesinteger(int32)required
createdAtstring(date-time)required
idinteger(int32)required
matchAllFiltersbooleanrequired
namestringrequired
recipientsArray of strings
updatedAtstring(date-time)required
]
Response
application/json
[
  {
    "accountId": 0,
    "checkTimes": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "id": 0,
    "matchAllFilters": true,
    "name": "string",
    "recipients": [ … ],
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

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