Skip to content
/Tag Health Report

V3 API

This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.

Download OpenAPI description
combined.openapi.json
combined.openapi.yaml
Overview
URL
https://www.observepoint.com/contact-us
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/

Alert Summary Report

Alert Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

Page Summary Report

Page Summary report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

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
pageSizeobject
redirectCountobject
hasBrokenLinksboolean
pageUrlMatchingAuditFilterConfigurationboolean
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
pageStatusCodestringDeprecated

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

Enum"good""redirects""broken"
tagStatusCodestringDeprecated

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

Enum"good""redirects""broken"
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
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageUrlMatchingAuditFilterConfiguration": 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
tagLoadTimeDistribution.​below500integerrequired

Number of tag requests with load time < 500 ms

tagLoadTimeDistribution.​500to1000integerrequired

Number of tag requests with 500 ms ≤ load time < 1000 ms

tagLoadTimeDistribution.​1000to2000integerrequired

Number of tag requests with 1000 ms ≤ load time < 2000 ms

tagLoadTimeDistribution.​above2000integerrequired

Number of tag requests with 2000 ms ≤ load time

tagStatusCodeDistributionobjectrequired

See StatusCodeEnum

tagStatusCodeDistribution.​goodintegerrequired

Number of tag requests with "good" status code

tagStatusCodeDistribution.​redirectintegerrequired

Number of tag requests with "redirect" status code

tagStatusCodeDistribution.​brokenintegerrequired

Number of tag requests with "broken" status code

Response
application/json
{
  "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
  }
}

Get Tag Health trends relative to for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends
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
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-health/trends \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Tag Health trends data

Bodyapplication/json
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
runs[].​totalTagLoadTimeAverageintegerrequired

Tag load time, in milliseconds

Default 0
runs[].​totalTagRequestSizeAverageintegerrequired

Tag network request size, in bytes

runs[].​totalSlowTagCountintegerrequired

Total number of tag request loaded slower than 2 sec

runs[].​slowTagPercentagenumber(double)

Percentage of tag requests loaded slower than 2 sec

runs[].​totalBrokenTagCountintegerrequired

Total number of broken tag requests (0, 400+ or 500+ HTTP status code)

runs[].​brokenTagPercentagenumber(double)

Percentage of tag requests loaded slower than 2 sec

runs[].​totalTagInstanceCountintegerrequired

Number of tag requests passing all applied filters

Response
application/json
{
  "runs": [
    { … }
  ]
}

Get Tag Health specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
trendNamestringrequired

name of requested trend

Enum"average_tag_load_time""average_tag_request_size""slow_tags""slow_tag_percentage""broken_tags""broken_tag_percentage""tag_requests"
Query
daysinteger[ 1 .. 390 ]required

Number of days to get trend values for, relative to current time

curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/reports/tag-health/trends/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Tag Health specific trend values

Bodyapplication/json
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
runs[].​trendValuenumberrequired
Response
application/json
{
  "runs": [
    { … }
  ]
}

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Account Usage Export

Export account usage data

Operations

Alert Export

Export alert data

Operations

Audit Run Export

Export audit run data

Operations

Exports Center

Access requested exports status/information

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Web Journey Run Export

Export web journey run data

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Alerts

Alert management and configuration

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations

Account Usage

Account usage data

Operations

Email Inbox Configuration

APIs for managing email inbox configurations and setting

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inboxes

APIs for getting email messages and results from email inboxes

Operations

Action Set Action Rules

APIs for managing Action Set Action Rules

Operations

Action Set Actions

APIs for managing Action Set Actions

Operations

Action Sets

APIs for managing Action Sets

Operations

Audit Actions

APIs for managing audit actions

Operations

Audit Blocking Config

APIs for managing audit request blocking configuration

Operations

Audit Login Actions

APIs for managing audit login actions

Operations

Audits Management

APIs for managing audits

Operations

Custom Headers

APIs for managing custom HTTP header groups

Operations

Data Sources

APIs for managing Data Sources

Operations

Geo Locations

APIs for geo locations

Operations

Notification Center

Find and manage email subscriptions

Operations

Remote File Mappings

APIs for managing Remote File Mappings

Operations

Rules

APIs for managing rules

Operations

Schedules

APIs for item schedules and calendars

Operations

Site Censuses

APIs for managing Site Census

Operations

User Events

APIs for managing User Events

Operations

Web Journey Blocking Config

APIs for managing web journey request blocking configuration

Operations

Web Journey Custom Headers

APIs for managing web journey custom headers

Operations

Web Journeys Management

APIs for managing Web Journeys

Operations