Skip to content
v3 API/
/
Create blocking configura...

Create blocking configuration for an Audit

Request

PUT /v3/web-audits/{auditId}/blocking-configuration
Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
Bodyapplication/jsonrequired

The Audit Blocking configuration to create

tagIdsArray of integers

(Optional) Present when blockingType is tag_id, a list of tag ids to block

tagCategoryIdsArray of integers

(Optional) Present when blockingType is tag_category, a list of tag category ids to block

PUT
/v3/web-audits/{auditId}/blocking-configuration
curl -i -X PUT \
  https://api.observepoint.com/v3/web-audits/107239/blocking-configuration \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tagIds": [
      0
    ],
    "tagCategoryIds": [
      0
    ]
  }'

Responses

Successfully returned the created Audit Blocking Configuration.

Bodyapplication/json
tagIdsArray of integers

(Optional) Present when blockingType is tag_id, a list of tag ids to block

tagCategoryIdsArray of integers

(Optional) Present when blockingType is tag_category, a list of tag category ids to block

Response
{
  "tagIds": [
    0
  ],
  "tagCategoryIds": [
    0
  ]
}