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
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory
- 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-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
},
"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,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"pagesWithoutTagId": 0,
"pagesWithoutTagCategoryId": 0,
"pagesWithoutTagVendorId": 0,
"pagesWithoutTag": {
"tagId": 0,
"tagAccount": "string"
}
}'
{ "totalPageCount": 0, "filteredPageCount": 0, "filteredBrokenPageCount": 0, "filteredUniqueTagCount": 0, "filteredBrokenTagCount": 0, "totalTagInstanceCount": 0 }
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
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tag-categories
- 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-inventory/tag-categories \
-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,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"pagesWithoutTagId": 0,
"pagesWithoutTagCategoryId": 0,
"pagesWithoutTagVendorId": 0,
"pagesWithoutTag": {
"tagId": 0,
"tagAccount": "string"
}
}'
{ "tagCategories": [ { … } ] }
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/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-inventory/trends \
-H 'Authorization: YOUR_API_KEY_HERE'
Tag Inventory 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
{ "runs": [ { … } ] }
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/reports/tag-inventory/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-inventory/trends/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'
Tag Inventory 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": [ { … } ] }
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
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/tags
- 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-inventory/tags \
-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,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"pagesWithoutTagId": 0,
"pagesWithoutTagCategoryId": 0,
"pagesWithoutTagVendorId": 0,
"pagesWithoutTag": {
"tagId": 0,
"tagAccount": "string"
}
}'
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
.
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/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-inventory/tags/{tagId}/accounts?page=0&size=100' \
-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",
"tagAccount": "string",
"pagesWithoutTagId": 0,
"pagesWithoutTagCategoryId": 0,
"pagesWithoutTagVendorId": 0
}'
{ "metadata": { "pagination": { … } }, "tagAccounts": [ { … } ] }
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
good - 2xx, redirects - 3xx, broken - all others
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/tag-inventory/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-inventory/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,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"pagesWithoutTagId": 0,
"pagesWithoutTagCategoryId": 0,
"pagesWithoutTagVendorId": 0,
"pagesWithoutTag": {
"tagId": 0,
"tagAccount": "string"
}
}'
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }