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.
v3 API//
- Get Tag Health summary for specified audit run
Get Tag Health trends relative to for specified audit run
Get Tag Health specific trend values relative to current day
Get Tag Health all tags list for specified audit run
Get Tag Health tag accounts list for specified audit run
Get Tag Health page list for specified audit run
Get Tag Health summary fo...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
Filters applicable to Tag Inventory report
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
if true then return only pages/tags with primary tags else return all pages/tags
good - 2xx, redirects - 3xx, broken - all others
Enum"good""redirects""broken"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}
}'Tag Health summary data
Number of tag request loadeded slower than 2 sec passing all applied filters
Percentage of tag requests loaded slower than 2 sec passing all applied filters
Number of broken tag requests (0, 400+ or 500+ HTTP status code) passing all applied filters
Percentage of tag requests loaded slower than 2 sec passing all applied filters
Number of tag requests with 500 ms ≤ load time < 1000 ms
Number of tag requests with 1000 ms ≤ load time < 2000 ms
See StatusCodeEnum
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 } }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/trends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/tag-health/trends \
-H 'Authorization: YOUR_API_KEY_HERE'Tag Health trends data
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- 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"
Total number of broken tag requests (0, 400+ or 500+ HTTP status code)
Response
application/json
{ "runs": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/reports/tag-health/trends/{trendName}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Tag Health specific trend values
Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:
- An uppercase T must separate the date and time portions.
- 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"
Response
application/json
{ "runs": [ { … } ] }