Skip to content
v3 API/
/
Get all triggered alerts...

Get all triggered alerts for the account

Request

POST /v3/account-triggered-alerts/alerts
Security
API_Key
Query
pageinteger, >= 0

Page number, starts with 0

Default:0
sizeinteger, [ 50 .. 1000 ]
Default:50
sortBystring
Enum:"RECENTLY_TRIGGERED_DATE""ALERT_NAME""REPORT_METRIC""PAGES_WITH_TRIGGERED_ALERTS""SUBSCRIBERS""DATA_SOURCES"
sortDescboolean

Controls sorting order

Default:false
Bodyapplication/json

Filters

runDateRangeobject

Should have from and/or to dates defined. from is inclusive and to is exclusive. to date should be after from date.

metricTypesArray of strings, non-empty
alertNamestring

when populated works as "alert name contains given substring" filter

alertLabelsArray of integers, non-empty

non-empty array of labels present on an alert

itemNamestring, non-empty

optional "item name contains substring" filter

itemLabelsArray of integers, non-empty

non-empty array of labels present on an item, works as "item has all specified labels" filter

itemTypestring
Enum:"AUDIT""WEB_JOURNEY"
foldersArray of objects, non-empty

non-empty array of folders with domains (subfolders), items from which will be included in response

subscribedOnlyboolean

when false or null then all alerts are returned, otherwise only alerts user is subscribed to are returned

POST
/v3/account-triggered-alerts/alerts
curl -i -X POST \
  'https://api.observepoint.com/v3/account-triggered-alerts/alerts?page=0&size=50&sortBy=RECENTLY_TRIGGERED_DATE&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "runDateRange": {
      "from": "2016-08-18T17:33:00Z",
      "to": "2016-08-18T17:33:00Z"
    },
    "metricTypes": [
      "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT"
    ],
    "alertName": "string",
    "alertLabels": [
      223
    ],
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "itemType": "AUDIT",
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ],
    "subscribedOnly": true
  }'

Responses

Returns account triggered alerts list

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

alertsArray of objects, >= 0 itemsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "alerts": [
    { … }
  ]
}