Skip to content
v3 API/
/
Get specific Alert by ID

Get specific Alert by ID

Request

GET /v3/alerts/{alertId}
Security
API_Key
Path
alertIdinteger, (int64)required
GET
/v3/alerts/{alertId}
curl -i -X GET \
  'https://api.observepoint.com/v3/alerts/{alertId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

alert definition

Bodyapplication/json
namestring, non-emptyrequired

User-defined name of the alert

metricTypestringrequired

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"
metricChangeTypestring

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"
targetValueComparatorobjectrequired
filtersV0objectrequired

Filters to be applied before computing the alert. Exact type depends on metricType, see mapping in AlertMetricTypeToFilterMapping

idinteger, (int64)required
labelsArray of integers, >= 0 itemsrequired
emailsArray of strings, >= 0 itemsrequired

List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles

customAlertMessagestring
notificationPolicystringrequired

Behaviour per type:

  • WHEN_NEWLY_TRIGGERED: (default) send alert when goes from "ok" to "triggered" (resets when no longer triggered)
  • ALWAYS_WHEN_TRIGGERED: send alert notification each time it is triggered per run
Enum:"WHEN_NEWLY_TRIGGERED""ALWAYS_WHEN_TRIGGERED"
isDefaultForNewDataSourcesbooleanrequired

Makes this alert selected by default in data-source (audit/WJ) creation UI. This is a user-specific flag.

Response
{
  "name": "string",
  "metricType": "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT",
  "metricChangeType": "VALUE_CHANGE",
  "targetValueComparator": {
    "operator": "GREATER",
    "targetValue": 0.1
  },
  "filtersV0": {},
  "id": 0,
  "labels": [
    223
  ],
  "emails": [
    "user@example.com"
  ],
  "customAlertMessage": "string",
  "notificationPolicy": "WHEN_NEWLY_TRIGGERED",
  "isDefaultForNewDataSources": true
}