This section documents the V3 Reporting API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, and analyze web performance metrics from your ObservePoint scans.
V3 API
https://api.observepoint.com/
Filters applicable to Tag Inventory report
broken
- initial or final URL arebroken
,good
- initial URL isgood
orredirect
and final URL isgood
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
.
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
.
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
.
if true then return only pages/tags with primary tags else return all pages/tags
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
.
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://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
{ "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 API
https://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
Total number of broken tag requests (0, 400+ or 500+ HTTP status code)
{ "runs": [ { … } ] }
- ObservePoint Production API
https://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
{ "runs": [ { … } ] }
For tag_loadtime_*
lower and upper bounds are correspondingly inclusive and exclusive
Filters applicable to Tag Inventory report
broken
- initial or final URL arebroken
,good
- initial URL isgood
orredirect
and final URL isgood
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
.
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
.
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
.
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
.
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/tags/{tagId}/accounts
- 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/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
},
"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",
"tagLoadTime": {
"min": 0,
"max": 0
},
"tagStatusCode": "good",
"tagAccount": "string",
"tagRequestSize": {
"min": 0,
"max": 0
}
}'
Tag Health tag accounts data
Common metadata for iterable
Total number of items available from all result pages combined
Page size - number of items per result page configured by size
query parameter or default page size
Number of tag requests with load time < 500 ms
Number of tag requests with 500 ms ≤ load time < 1000 ms
Number of tag requests with 1000 ms ≤ load time < 2000 ms
See StatusCodeEnum
Number of tag requests with "good" status code
Number of tag requests with "redirect" status code
{ "metadata": { "pagination": { … } }, "tagAccounts": [ { … } ] }
Filters applicable to Tag Health report
broken
- initial or final URL arebroken
,good
- initial URL isgood
orredirect
and final URL isgood
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
.
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
.
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
.
if true then return only pages/tags with primary tags else return all pages/tags
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
.
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-health/pages
- 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/pages?page=0&size=50&sortBy=page_url&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
},
"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
}
}'
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }