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 target items (data sources) that have specified Alert assigned
Create Alert
Get specific Alert by ID
Update specific Alert
Delete specific Alert
Update labels for an 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
Search Alerts for assigning them to other items (audits, WJs etc)
Update Alerts assigned to specified item (audit, journey etc)
Update target items (data...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/json
if alertId is NOT specified, assignedToAlert is ignored. if alertId IS specified assignedToAlert has 3 states: when TRUE - only items assigned to the specified alert will be returned; when FALSE - only NOT assigned; when NOT specified or NULL - both assigned and not assigned items will be returned
ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum
non-empty array of labels present on an item, works as "item has all specified labels" filter
Example: [223]
- ObservePoint Production APIhttps://api.observepoint.com/v3/alerts/target-items/{itemType}/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/alerts/target-items/{itemType}/search?size=50&page=0&sortBy=IS_ASSIGNED&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"alertId": 0,
"assignedToAlert": true,
"itemName": "string",
"itemId": 0,
"itemLabels": [
223
],
"folders": [
{
"folderId": 123,
"domains": [
123
]
}
]
}'Items (data sources) that may have specified Alert assigned or not assigned
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
ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum
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": { … } }, "items": [ { … } ] }
Bodyapplication/json
ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum
- ObservePoint Production APIhttps://api.observepoint.com/v3/alerts/{alertId}/target-items
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api.observepoint.com/v3/alerts/{alertId}/target-items' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"assignmentUpdates": [
{
"scope": "SINGLE_ITEM",
"itemType": "AUDIT",
"itemId": 0,
"operation": "ASSIGN"
}
]
}'Query
Bodyapplication/jsonBehaviour per type:
- REPORT_METRIC: sort by name of data/report type corresponding to alert's
metricType
Enum"ALERT_NAME""REPORT_METRIC"
non-empty array of labels present on an alert, works as "alert has all specified labels" filter
Example: [223]
- ObservePoint Production APIhttps://api.observepoint.com/v3/alerts/search/assignments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.observepoint.com/v3/alerts/search/assignments?size=50&page=0&sortBy=ALERT_NAME&sortDesc=false' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"targetItem": {
"itemType": "AUDIT",
"itemId": 0,
"isAssigned": true
},
"search": "string",
"labels": [
223
],
"isDefaultForNewDataSources": true
}'Assignments
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"
Response
application/json
{ "metadata": { "pagination": { … } }, "alerts": [ { … } ] }