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//
- Return insights on a given page for all runs in the given duration
get page summary insights
Get insights by page
Return insights for all runs in the given duration
Get Page Summary Web Vitals trends relative to specified audit run
Get Page Summary Web Vitals specific trend values relative to current day
Return insights on a give...
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/page-summary/trends/web-vitals
- 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/page-summary/trends/web-vitals \
-H 'Authorization: YOUR_API_KEY_HERE'Page Summary Web Vitals 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"
Web Vitals trends statistics (min, max, average, median, 25th and 75th percentiles)
Web Vitals trends statistics (min, max, average, median, 25th and 75th percentiles)
Web Vitals trends statistics (min, max, average, median, 25th and 75th percentiles)
Web Vitals trends statistics (min, max, average, median, 25th and 75th percentiles)
Response
application/json
{ "runs": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/reports/page-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/page-summary/trends/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'list of page insight
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/page-summary/trends/web-vitals/{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/page-summary/trends/web-vitals/{trendName}?days=1' \
-H 'Authorization: YOUR_API_KEY_HERE'Page Summary Web Vitals 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"
Distribution of pages by buckets of web vitals values
Web Vitals trends statistics (min, max, average, median, 25th and 75th percentiles)
Response
application/json
{ "runs": [ { … } ] }