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 specific alert data (config + result) for specified audit run
Get Alerts statuses overview for specified audit run
Get Alert Summary alerts table data for specified audit run
Get specific alert data (...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
Filters applicable to Alert Summary report
Items Enum"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT""ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT"
Simplified version of #/components/schemas/AlertResultStatusEnum for UI filters
Enum"TRIGGERED""NOT_TRIGGERED"
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts
- 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/alert-summary/alerts?page=0&size=50&sortBy=ALERT_NAME&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"alertName": "string",
"metricTypes": [
"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
],
"status": "TRIGGERED",
"subscribedOnly": true
}'Alert Summary alerts data
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
Deprecated metric types:
- ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT
- ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT
- ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT
- ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT
- ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT
- PAGE_SUMMARY_FAILED_RULE_COUNT
Enum"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT""ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT"
Behaviour per type:
- VALUE_CHANGE: current - previous
- VALUE_CHANGE_ABS: ABS(current - previous)
- RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous
- RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)
Composite metric change operators shown on ObservePoint UI should be defined as described below:
Changes by (∆)= VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)Increases by (+)= VALUE_CHANGE + GREATER_OR_EQUAL(positive number)Decreases by (-)= VALUE_CHANGE + LESS_OR_EQUAL(negative number)Any change= VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)Changes by (∆ %)= RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)Increases by (+%)= RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)Decreases by (-%)= RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)
Enum"VALUE_CHANGE""VALUE_CHANGE_ABS""RELATIVE_VALUE_CHANGE""RELATIVE_VALUE_CHANGE_ABS"
Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator
Enum"GREATER""GREATER_OR_EQUAL""EQUAL""NOT_EQUAL""LESS_OR_EQUAL""LESS""BETWEEN""NOT_BETWEEN"
Discriminator
- GREATER
- GREATER_OR_EQUAL
- EQUAL
- NOT_EQUAL
- LESS_OR_EQUAL
- LESS
- BETWEEN
- NOT_BETWEEN
Filters to be applied before computing the alert. Exact type depends on metricType, see mapping in AlertMetricTypeToFilterMapping
All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:
- UNKNOWN_ERROR: data retrieval or alert computation failed
- RUN_NOT_FOUND: requested run not found
- NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
- PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
- PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value
Returns up to 20 runs with alert results
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"
All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:
- UNKNOWN_ERROR: data retrieval or alert computation failed
- RUN_NOT_FOUND: requested run not found
- NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
- PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
- PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value
Response
application/json
{ "metadata": { "pagination": { … } }, "alerts": [ { … } ] }
- ObservePoint Production APIhttps://api.observepoint.com/v3/web-audits/{auditId}/runs/{runId}/reports/alert-summary/alerts/{alertId}
- 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/alert-summary/alerts/{alertId}' \
-H 'Authorization: YOUR_API_KEY_HERE'Alert Summary specific alert data
Deprecated metric types:
- ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT
- ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT
- ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT
- ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT
- ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT
- PAGE_SUMMARY_FAILED_RULE_COUNT
Enum"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT""ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT""ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT""ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE""ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT"
Behaviour per type:
- VALUE_CHANGE: current - previous
- VALUE_CHANGE_ABS: ABS(current - previous)
- RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous
- RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)
Composite metric change operators shown on ObservePoint UI should be defined as described below:
Changes by (∆)= VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)Increases by (+)= VALUE_CHANGE + GREATER_OR_EQUAL(positive number)Decreases by (-)= VALUE_CHANGE + LESS_OR_EQUAL(negative number)Any change= VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)Changes by (∆ %)= RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)Increases by (+%)= RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)Decreases by (-%)= RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)
Enum"VALUE_CHANGE""VALUE_CHANGE_ABS""RELATIVE_VALUE_CHANGE""RELATIVE_VALUE_CHANGE_ABS"
Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator
Enum"GREATER""GREATER_OR_EQUAL""EQUAL""NOT_EQUAL""LESS_OR_EQUAL""LESS""BETWEEN""NOT_BETWEEN"
Discriminator
- GREATER
- GREATER_OR_EQUAL
- EQUAL
- NOT_EQUAL
- LESS_OR_EQUAL
- LESS
- BETWEEN
- NOT_BETWEEN
Filters to be applied before computing the alert. Exact type depends on metricType, see mapping in AlertMetricTypeToFilterMapping
All statuses except TRIGGERED and NOT_TRIGGERED mean that alert/metric could not be computed. Statuses:
- UNKNOWN_ERROR: data retrieval or alert computation failed
- RUN_NOT_FOUND: requested run not found
- NO_VALUE: no data found for requested run (e.g. rules or consent categories were not applied)
- PREVIOUS_RUN_NOT_FOUND: previous run not found for run-over-run metric change alert
- PREVIOUS_RUN_NO_VALUE: no data found for previous run for run-over-run metric change alert
Enum"TRIGGERED""NOT_TRIGGERED""UNKNOWN_ERROR""RUN_NOT_FOUND""NO_VALUE""PREVIOUS_RUN_NOT_FOUND""PREVIOUS_RUN_NO_VALUE"
Value of computed metric for current run. Present when alert is configured on metric change, not on single run metric value
Response
application/json
{ "id": 0, "config": { "name": "string", "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT", "metricChangeType": "VALUE_CHANGE", "targetValueComparator": { … }, "filtersV0": {}, "subscriberCount": 0, "isUserSubscribed": true }, "result": { "status": "TRIGGERED", "actualValue": 0.1, "currentRunValue": 0.1, "previousRunValue": 0.1 }, "alertConfigExists": true }