Skip to content
v3 API/
/
Get Variable Inventory su...

Get Variable Inventory summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory
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 Variable 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

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

tagAccountstring

Tag account

POST
/v3/web-audits/{auditId}/runs/{runId}/reports/variable-inventory
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/variable-inventory \
  -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,
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "tagAccount": "string"
  }'

Responses

Variable Inventory summary data

Bodyapplication/json
totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

filteredUniqueTagCountintegerrequired

Number of unique tag vendors passing all applied filters

totalTagInstanceCountintegerrequired

Total number of tag requests discovered

filteredTagInstanceCountintegerrequired

Number of tag requests passing all applied filters

totalUniqueVariableNameCountintegerrequired

Total number of unique variable names across all tags

filteredUniqueVariableNameCountintegerrequired

Number of unique variable names across all tags passing all applied filters

totalUniqueVariableValueCountintegerrequired

Total number of unique variable names across all tags

filteredUniqueVariableValueCountintegerrequired

Number of unique variable names across all tags passing all applied filters

Response
{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "filteredUniqueTagCount": 0,
  "totalTagInstanceCount": 0,
  "filteredTagInstanceCount": 0,
  "totalUniqueVariableNameCount": 0,
  "filteredUniqueVariableNameCount": 0,
  "totalUniqueVariableValueCount": 0,
  "filteredUniqueVariableValueCount": 0
}