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/
- ObservePoint Production API
https://api.observepoint.com/v3/usage/alert-summary/alerts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.observepoint.com/v3/usage/alert-summary/alerts \
-H 'Authorization: YOUR_API_KEY_HERE'Alert Summary alerts data
Core parts of alert definition
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
{ "alerts": [ { … } ] }