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 Audit Summary trends relative to specified audit run
Get Audit Summary data for specified audit run
Get Audit Summary specific trend values relative to current day
Get Audit Summary all primary tags data for specified audit run
Get Audit Summary all detected tags data for specified audit run
Get Audit Summary scores for specified audit run
Get Audit Summary scores trends relative to specified audit run
Get Audit Summary specific score trend values relative to current time
Get Audit Summary trends...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
Filters applicable to Audit Summary report
(This filter option no longer works due to the response body change on May 2021) if true then return only pages/tags with primary tags else return all pages/tags
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary
- 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/audit-summary \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0
}'Response
application/json
{ "totalUniquePrimaryTagCount": 0, "filteredUniquePrimaryTagCount": 0 }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/audit-summary/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/audit-summary/trends \
-H 'Authorization: YOUR_API_KEY_HERE'Audit Summary 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"
Response
application/json
{ "runs": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/reports/audit-summary/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/audit-summary/trends/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'Audit Summary 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": [ { … } ] }