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 Inventory tag presence for specified audit run
Get Tag Inventory summary for specified audit run
Get Tag Inventory tag categories summary for specified audit run
Get Tag Inventory trends relative to specified audit run
Get Tag Inventory specific trend values relative to current time
Get Tag Inventory tag accounts presence for specified audit run
Get Tag Inventory page info for specified audit run
Get Tag Inventory tag pre...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com
- ObservePoint Production APIhttps://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
Example: "2016-08-18T17:33:00Z"
Response
application/json
{ "runs": [ { … } ] }
Bodyapplication/json
Filters applicable to Tag Inventory report
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
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
Enum"good""redirects""broken"
- ObservePoint Production APIhttps://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"
}
}'Security
API_Key
Filters applicable to Tag Inventory report
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
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 APIhttps://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
}'Response
application/json
{ "metadata": { "pagination": { … } }, "tagAccounts": [ { … } ] }