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 labels for an Alert
Create Alert
Get specific Alert by ID
Update specific Alert
Delete specific Alert
Get Alerts Library items
Get Alerts by metric
Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned
Update target items (data sources) that have specified Alert assigned
Search Alerts for assigning them to other items (audits, WJs etc)
Update Alerts assigned to specified item (audit, journey etc)
Update labels for an Aler...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com
- ObservePoint Production APIhttps://api.observepoint.com/v3/alerts/{alertId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api.observepoint.com/v3/alerts/{alertId}' \
-H 'Authorization: YOUR_API_KEY_HERE'- ObservePoint Production APIhttps://api.observepoint.com/v3/alerts/{alertId}/labels
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api.observepoint.com/v3/alerts/{alertId}/labels' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"labels": [
223
]
}'Bodyapplication/json
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"
- ObservePoint Production APIhttps://api.observepoint.com/v3/alerts/library
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/alerts/library?size=50&page=0&sortDesc=false&sortBy=ALERT_NAME' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"alertName": "string",
"metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
"labels": [
223
],
"createdByUserId": 123,
"isSubscribed": false
}'Alerts Library items
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"
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": [ { … } ] }