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 page rule results within specified audit run
Get rule summary for specified audit run
Get rule status trends for specified audit run
Get rule results trend values for specified audit run relative to current day
Get rule results page count trend values for specified audit run relative to current day
Get all rules overview for specified audit run
Get rule details for specified rule within specified audit run
Get specific rule page results within specified audit run
Get page rule results wit...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
Filters (page filtering supported only)
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
if true then return only rules/pages with primary tags else return all rules/pages
good - 2xx, redirects - 3xx, broken - all others
Enum"good""redirects""broken"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/rule-results/{ruleSnapshotId}
- 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/rule-summary/rule-results/{ruleSnapshotId}' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true
},
"combinedPageStatusCode": "broken",
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageSize": {
"min": 0,
"max": 0
},
"redirectCount": {
"min": 0,
"max": 0
},
"hasBrokenLinks": true,
"pageUrlMatchingAuditFilterConfiguration": true,
"pageStatusCode": "good",
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"ruleFailuresOnly": true,
"ruleStatus": "failed"
}'Rule Details by Page - single rule details
List of tags checked in the rule
Number of pages with at least 1 rule not applied
Default 0
Enum"Unknown""TagPresent""Equals""NotEqual""Contains""DoesNotContain""Regex""IsSet""NotSet""GreaterThanOrEquals"
Number of pages with at least 1 rule failed
Default 0
Number of pages with at least 1 rule passed
Default 0
Number of pages with at least 1 rule not applied
Default 0
1 - url, 2 - status code, 3 - final url, 4 - final status code
Enum1234
Response
application/json
{ "failedRulePageCount": 0, "passedRulePageCount": 0, "notAppliedRulePageCount": 0, "ruleSnapshotId": 0, "originalRuleId": 0, "ruleConfigExists": true, "name": "string", "tags": [ { … } ], "hasEmailNotification": true, "emailRecipients": [ "user@example.com" ], "pageFilters": [ { … } ] }
Query
Bodyapplication/json Enum"page_url""final_page_url""page_status_code""final_page_status_code""page_load_time""rule_failures"
Filters
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
if true then return only rules/pages with primary tags else return all rules/pages
good - 2xx, redirects - 3xx, broken - all others
Enum"good""redirects""broken"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results
- 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/rule-summary/page-rule-results?page=0&size=50&sortBy=page_url&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true
},
"combinedPageStatusCode": "broken",
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageSize": {
"min": 0,
"max": 0
},
"redirectCount": {
"min": 0,
"max": 0
},
"hasBrokenLinks": true,
"pageUrlMatchingAuditFilterConfiguration": true,
"pageStatusCode": "good",
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"ruleFailuresOnly": true,
"ruleStatus": "failed",
"ruleId": 12
}'Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }
Bodyapplication/json
Filters
broken- initial or final URL arebroken,good- initial URL isgoodorredirectand final URL isgood
Enum"broken""good"
if true then return only rules/pages with primary tags else return all rules/pages
Optionally filters by a specific component within the rule's logic (e.g., a tag or variable condition). When used with filterType = tag_filter or tag_variable_filter, it overrides the default behavior of the ruleResultType filter, applying it to this specific component's outcome
good - 2xx, redirects - 3xx, broken - all others
Enum"good""redirects""broken"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/rule-summary/page-rule-results/{ruleSnapshotId}
- 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/rule-summary/page-rule-results/{ruleSnapshotId}?page=0&size=50&sortBy=page_url&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"pageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"finalPageUrl": {
"filterType": "contains",
"filterValue": "string",
"negated": false
},
"pageTitle": {
"filterType": "contains",
"filterValue": "ObserveP"
},
"initialPageStatusCode": {
"filterType": "specific",
"negated": true
},
"finalPageStatusCode": {
"filterType": "specific",
"negated": true
},
"combinedPageStatusCode": "broken",
"pageLoadTime": {
"min": 0,
"max": 0
},
"pageSize": {
"min": 0,
"max": 0
},
"redirectCount": {
"min": 0,
"max": 0
},
"hasBrokenLinks": true,
"pageUrlMatchingAuditFilterConfiguration": true,
"pageStatusCode": "good",
"primaryTagsOnly": true,
"tagId": 0,
"tagCategoryId": 0,
"tagVendorId": 0,
"tagAccount": "string",
"ruleFailuresOnly": true,
"ruleStatus": "failed",
"ruleFilter": {
"filterType": "page_filter"
},
"ruleResultType": "passed"
}'Pages list with rule condition details (when specific rule condition/outcome is selected)
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
Only tag variable condition has parent - tag condition
condition snapshot ID. One of: RulePageFilterSnapshotId, RuleTagSnapshotId, RuleTagVariableSnapshotId
The rule condition expected values
Response
application/json
{ "metadata": { "pagination": { … } }, "pages": [ { … } ] }