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//
- Update audit notes
Get list of web audits
Get latest runs for web audits
Get audit notes by ID
run audit now
Get audit configuration info for specified audit run
Get all the consent categories assigned to an audit
Update the consent categories assigned to an audit
Retrieve all consent categories snapshots that are applied to a specific audit run.
Reprocess consent-category for the selected auditId and runIds
Update audit notes
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}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/web-audits/107239 \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "id": 0, "notes": "string" }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://api.observepoint.com/v3/web-audits/107239 \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"notes": "string"
}'Response
application/json
{ "id": 0, "notes": "string" }
Bodyapplication/jsonrequired
Run the audit now. The request must contain the web-audit ID. Unlike v2 "run now" API, this API does not reject run requests if there is an active run.
The workflow file to be used in for starting the callback workflow Has to be a file name without extension, e.g. "audit-complete" instead of "audit-complete.yml"
The owner of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow
The name of the repository where the callback workflow is defined This is required to correctly invoke the callback workflow
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs
- 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 \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"startingUrls": [
"string"
],
"callbackWorkflowEventType": "string",
"callbackRepositoryOwner": "string",
"callbackRepositoryName": "string",
"callbackContext": {}
}'