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 Request Privacy specific trend values relative to current day
Get Request Privacy summary for specified audit run
Get Request Privacy trends relative to specified audit run
Get Request Privacy locations for specified audit run
Get Request Privacy compliance for specified audit run
Get Request Privacy pages data for specified audit run
Get Request Privacy pages data for specific request in specified audit run
Get Request Privacy speci...
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}/runs/{runId}/reports/request-privacy/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/request-privacy/trends \
-H 'Authorization: YOUR_API_KEY_HERE'Request Privacy 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 unique network request domains discovered
Total number of unique network request geolocations discovered
Total number of unique approved request domains discovered
Total number of unique unapproved domains discovered
Total number of approved domain+geo pairs discovered
Response
application/json
{ "runs": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/reports/request-privacy/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/request-privacy/trends/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'Request Privacy 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 Request Privacy report. countryCode filter is not abided by this endpoint.
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
Example: 33010
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/request-privacy/locations
- 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/request-privacy/locations \
-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,
"requestDomain": "example.com",
"consentCategoryId": 3301,
"consentCategorySnapshotId": 33010,
"consentCategoryComplianceStatus": "approved",
"countryCode": "US"
}'Response
application/json
{ "locations": [ { … } ] }