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 for all runs in the given duration
get page summary insights
Get insights by page
Get Page Summary Web Vitals trends relative to specified audit run
Return insights on a given page for all runs in the given duration
Get Page Summary Web Vitals specific trend values relative to current day
Return insights for all r...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Query
Bodyapplication/json Enum"page_url""page_status_code""size""page_load_time""final_page_url""page_title""initial_page_status_code""final_page_status_code""redirect_count""largest_contentful_paint"
Filters
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
Usage:
false- only pages that do not have a parent page will be returned - starting URLstrue- only pages that have a parent page will be returned - pages that were discovered during crawlingnullor undefined - all pages will be returned.
non-empty list of kinds of errors present on a page, depends on filterType:
ALL: page has all types of errors specified inerrorTypeslistANY: page has any type of errors present in specifiederrorTypeslist
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/page-summary/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/page-summary/pages?page=0&size=50&sortBy=page_url&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageStatusCode": "good",
"pageSize": {
"min": 0,
"max": 0
},
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagAccount": "string",
"tagVendorId": 0,
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true
},
"hasBrokenLinks": true,
"redirectCount": {
"min": 0,
"max": 0
},
"combinedPageStatusCode": "broken",
"hasParentPage": true,
"pageUrlMatchingAuditFilterConfiguration": true,
"errors": {
"filterType": "ALL",
"errorTypes": [
"ON_PAGE_ACTION_ERROR"
]
},
"largestContentfulPaint": {
"min": 0,
"max": 0
},
"firstContentfulPaint": {
"min": 0,
"max": 0
},
"timeToFirstByte": {
"min": 0,
"max": 0
},
"cumulativeLayoutShift": {
"min": 0.1,
"max": 0.1
}
}'OK, return insights by page
Common metadata for iterable
Total number of items available from all result pages combined
Page size - number of items per result page configured by size query parameter or default page size
Number of redirects from initialUrl to finalUrl of the page or 0 if none
error produced by browser upon opening the page
Example: "This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED"
Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/page-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/page-summary/trends \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "runs": [ { … } ] }
- 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": [ { … } ] }