Skip to content
v3 API/
/
Get Tag Health tag accoun...

Get Tag Health tag accounts list for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts
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
tagIdintegerrequired

Tag ID

Query
pageinteger, >= 0

Page number, starts with 0

Default:0
sizeinteger, [ 100 .. 1000 ]
Default:100
sortBystring

For tag_loadtime_* lower and upper bounds are correspondingly inclusive and exclusive

Enum:"tag_account""tag_instance_count""tag_request_size_average""tag_load_time_below_500""tag_load_time_from_500_to_1000""tag_load_time_from_1000_to_2000""tag_load_time_above_2000"
sortDescboolean

Controls sorting order

Default:false
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.

tagLoadTimeobject

Should have min and/or max properties defined

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/tags/{tagId}/accounts
curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-health/tags/{tagId}/accounts?page=0&size=100&sortBy=tag_account&sortDesc=false' \
  -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",
    "tagLoadTime": {
      "min": 0,
      "max": 0
    },
    "tagStatusCode": "good",
    "tagAccount": "string",
    "tagRequestSize": {
      "min": 0,
      "max": 0
    }
  }'

Responses

Tag Health tag accounts data

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

tagAccountsArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "tagAccounts": [
    { … }
  ]
}