Skip to content
v3 API/
/
Get information about spe...

Get information about specific alert from all triggered alerts for the account

Request

POST /v3/account-triggered-alerts/alerts/{alertId}
Security
API_Key
Path
alertIdinteger, (int64)required
Query
pageinteger, >= 0

Page number, starts with 0

Default:0
sizeinteger, [ 50 .. 1000 ]
Default:50
sortBystring
Enum:"RUN_DATE""DATA_SOURCE_NAME""PAGES_WITH_TRIGGERED_ALERTS"
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.

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

POST
/v3/account-triggered-alerts/alerts/{alertId}
curl -i -X POST \
  'https://api.observepoint.com/v3/account-triggered-alerts/alerts/{alertId}?page=0&size=50&sortBy=RUN_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"
    },
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "itemType": "AUDIT",
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ]
  }'

Responses

Returns account triggered alerts specific alert details

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

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