Skip to content
v3 API/
/
Get Audit Summary all det...

Get Audit Summary all detected tags data for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags
Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
runIdinteger, (int64)required

Unique identification number for web audit or journey run

Example:33010
Bodyapplication/json

Filters applicable to Audit Summary report

primaryTagsOnlyboolean

(This filter option no longer works due to the response body change on May 2021) if true then return only pages/tags with primary tags else return all pages/tags

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

POST
/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/tags
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/audit-summary/tags \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0
  }'

Responses

Audit Summary all detected tags data

Bodyapplication/json
tagsArray of objectsrequired
Response
{
  "tags": [
    { … }
  ]
}