Skip to content
v3 API/
/
Get Tag Health summary fo...

Get Tag Health summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health
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 Tag Inventory report

pageUrlobject
finalPageUrlobject
pageTitleobject
initialPageStatusCodeobject
finalPageStatusCodeobject
combinedPageStatusCodestring
  • broken - initial or final URL are broken,
  • good - initial URL is good or redirect and final URL is good
Enum:"broken""good"
pageLoadTimeobject

Page load time in milliseconds. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

pageSizeobject

Page size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

redirectCountobject

Number of redirects for a page. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

primaryTagsOnlyboolean

if true then return only pages/tags with primary tags else return all pages/tags

tagLoadTimeobject

Should have min and/or max properties defined

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

tagAccountstring

Tag account

tagRequestSizeobject

Tag request size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

pageStatusCodestringdeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum:"good""redirects""broken"
tagStatusCodestringdeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum:"good""redirects""broken"
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-health \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageUrl": {
      "filterType": "contains",
      "filterValue": "string",
      "negated": false
    },
    "finalPageUrl": {
      "filterType": "contains",
      "filterValue": "string",
      "negated": false
    },
    "pageTitle": {
      "filterType": "contains",
      "filterValue": "ObserveP"
    },
    "initialPageStatusCode": {
      "filterType": "specific",
      "negated": true,
      "filterValue": 0
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true,
      "filterValue": 0
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageStatusCode": "good",
    "primaryTagsOnly": true,
    "tagLoadTime": {
      "min": 0,
      "max": 0
    },
    "tagStatusCode": "good",
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "tagAccount": "string",
    "tagRequestSize": {
      "min": 0,
      "max": 0
    }
  }'

Responses

Tag Health summary data

Bodyapplication/json
totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

filteredTagLoadTimeAverageintegerrequired

Tag load time, in milliseconds

Default:0
filteredTagRequestSizeAverageintegerrequired

Tag network request size, in bytes

filteredSlowTagCountintegerrequired

Number of tag request loadeded slower than 2 sec passing all applied filters

filteredSlowTagPercentagenumber, (double)required

Percentage of tag requests loaded slower than 2 sec passing all applied filters

filteredBrokenTagCountintegerrequired

Number of broken tag requests (0, 400+ or 500+ HTTP status code) passing all applied filters

filteredBrokenTagPercentagenumber, (double)required

Percentage of tag requests loaded slower than 2 sec passing all applied filters

filteredTagInstanceCountintegerrequired

Number of tag requests passing all applied filters

tagLoadTimeDistributionobjectrequired
tagStatusCodeDistributionobjectrequired

See StatusCodeEnum

Response
{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "filteredTagLoadTimeAverage": 0,
  "filteredTagRequestSizeAverage": 0,
  "filteredSlowTagCount": 0,
  "filteredSlowTagPercentage": 0.1,
  "filteredBrokenTagCount": 0,
  "filteredBrokenTagPercentage": 0.1,
  "filteredTagInstanceCount": 0,
  "tagLoadTimeDistribution": {
    "below500": 0,
    "500to1000": 0,
    "1000to2000": 0,
    "above2000": 0
  },
  "tagStatusCodeDistribution": {
    "good": 0,
    "redirect": 0,
    "broken": 0
  }
}