Get Alerts by metric

Request

GET /v3/alerts/metrics/{metricType}

Security

API_Key

Path

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"

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

GET

/v3/alerts/metrics/{metricType}

curl -i -X GET \
  'https://api.observepoint.com/v3/alerts/metrics/{metricType}?size=50&page=0&sortDesc=false&sortBy=ALERT_NAME' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

All alerts in an account with the same metric

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

alertsArray of objectsrequired

Response

{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}