This section documents the V3 Reporting API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, and analyze web performance metrics from your ObservePoint scans.
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Path
Controls accepted values and their bytes for page size, sortBy and request body
Enum"AUDIT_SUMMARY_DETECTED_TAGS""RULE_SUMMARY_PAGE_RESULTS""RULE_SUMMARY_PAGE_RULE_RESULTS""PAGE_SUMMARY_PAGES""PAGE_SUMMARY_BROKEN_SCANNED_LINKS""TAG_INVENTORY_PAGES""TAG_HEALTH_PAGES""TAG_DUPLICATES_AND_MULTIPLES_PAGES""VARIABLE_INVENTORY_TAG_ACCOUNT_PAGES""VARIABLE_INVENTORY_TAG_ACCOUNT_VARIABLE_PAGES"
Query
Bodyapplication/jsonIF false THEN only one results page will be exported ELSE all data will be exported
Default false
Filters
object
Exact type depends on exportType param, see mapping in AuditRun_ExportTypeToFilterMapping
- ObservePoint Production API
https://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/exports/{exportType}
- 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/exports/{exportType}?page=0&size=0&sortBy=string&sortDesc=false&allData=false&noLimit=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "exportId": 0 }