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/
Bodyapplication/json
Filters
Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.
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"
non-empty array of labels present on an item, works as "item has all specified labels" filter
non-empty array of folders with domains (subfolders), items from which will be included in response
- ObservePoint Production API
https://api.observepoint.com/v3/account-triggered-alerts/summary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.observepoint.com/v3/account-triggered-alerts/summary \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"runDateRange": {
"from": "2016-08-18T17:33:00Z",
"to": "2016-08-18T17:33:00Z"
},
"metricTypes": [
"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
],
"alertName": "string",
"alertLabels": [
0
],
"itemName": "string",
"itemLabels": [
0
],
"itemType": "AUDIT",
"folders": [
{
"folderId": 123,
"domains": [
123
]
}
],
"subscribedOnly": true
}'Response
application/json
{ "triggeredAlertAffectedPageCount": 0, "triggeredAlertsInMostRecentRunCount": 0, "auditsWithTriggeredAlertCount": 0, "triggeredUsageAlertCount": 0 }
Query
Bodyapplication/json Enum"RECENTLY_TRIGGERED_DATE""ALERT_NAME""REPORT_METRIC""PAGES_WITH_TRIGGERED_ALERTS""SUBSCRIBERS""DATA_SOURCES"
Filters
Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.
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"
non-empty array of labels present on an item, works as "item has all specified labels" filter
non-empty array of folders with domains (subfolders), items from which will be included in response
- ObservePoint Production API
https://api.observepoint.com/v3/account-triggered-alerts/alerts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/account-triggered-alerts/alerts?page=0&size=50&sortBy=RECENTLY_TRIGGERED_DATE&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"runDateRange": {
"from": "2016-08-18T17:33:00Z",
"to": "2016-08-18T17:33:00Z"
},
"metricTypes": [
"ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
],
"alertName": "string",
"alertLabels": [
0
],
"itemName": "string",
"itemLabels": [
0
],
"itemType": "AUDIT",
"folders": [
{
"folderId": 123,
"domains": [
123
]
}
],
"subscribedOnly": true
}'Returns account triggered alerts list
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
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"
Response
application/json
{ "metadata": { "pagination": { … } }, "alerts": [ { … } ] }
Bodyapplication/json
Filters
Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.
non-empty array of labels present on an item, works as "item has all specified labels" filter
- ObservePoint Production API
https://api.observepoint.com/v3/account-triggered-alerts/alerts/{alertId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/account-triggered-alerts/alerts/{alertId}?page=0&size=50&sortBy=RUN_DATE&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"runDateRange": {
"from": "2016-08-18T17:33:00Z",
"to": "2016-08-18T17:33:00Z"
},
"itemName": "string",
"itemLabels": [
0
],
"itemType": "AUDIT",
"folders": [
{
"folderId": 123,
"domains": [
123
]
}
]
}'Returns account triggered alerts specific alert details
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
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
Value of computed metric for previous run. Present when alert is configured on metric change, not on single run metric value
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"
Response
application/json
{ "metadata": { "pagination": { … } }, "dataSources": [ { … } ] }