Skip to content
v3 API/
/
Get Alerts Library items

Get Alerts Library items

Request

POST /v3/alerts/library
Security
API_Key
Query
sizeinteger, [ 50 .. 1000 ]
Default:50
pageinteger, >= 0

Page number, starts with 0

Default:0
sortDescboolean

Controls sorting order

Default:false
sortBystring
Enum:"ALERT_NAME""TARGET_ITEMS""REPORT_METRIC""UPDATED_AT""SUBSCRIBERS"
Bodyapplication/json
alertNamestring, non-empty

when present works as "alert name contains give substring` filter

metricTypestring

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"
labelsArray of integers, non-empty
createdByUserIdinteger

ID of a user

Example:123
isSubscribedboolean

When true then only those alerts will be returned that have Notification Profile of a requestor user assigned onto them

Default:false
POST
/v3/alerts/library
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
  }'

Responses

Alerts Library items

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

alertsArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}