Skip to content
v3 API/
/
Search target items (data...

Search target items (data sources - audits, journeys etc) that may have specified Alert assigned or not assigned

Request

POST /v3/alerts/target-items/{itemType}/search
Security
API_Key
Path
itemTypestringrequired
Enum:"AUDIT""WEB_JOURNEY"
Query
sizeinteger, [ 50 .. 1000 ]
Default:50
pageinteger, >= 0

Page number, starts with 0

Default:0
sortBystring
Enum:"IS_ASSIGNED""ITEM_NAME""RUN_DATE"
sortDescboolean

Controls sorting order

Default:false
Bodyapplication/json
alertIdinteger, (int64)
assignedToAlertboolean

if alertId is NOT specified, assignedToAlert is ignored. if alertId IS specified assignedToAlert has 3 states: when TRUE - only items assigned to the specified alert will be returned; when FALSE - only NOT assigned; when NOT specified or NULL - both assigned and not assigned items will be returned

itemNamestring, non-empty

optional "item name contains substring" filter

itemIdinteger, (int64)

ID of the item that can have assigned Alert(s) onto it. See also AlertAssignmentTypeEnum

itemLabelsArray of integers, non-empty

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

foldersArray of objects, non-empty

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

POST
/v3/alerts/target-items/{itemType}/search
curl -i -X POST \
  'https://api.observepoint.com/v3/alerts/target-items/{itemType}/search?size=50&page=0&sortBy=IS_ASSIGNED&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "alertId": 0,
    "assignedToAlert": true,
    "itemName": "string",
    "itemId": 0,
    "itemLabels": [
      223
    ],
    "folders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ]
  }'

Responses

Items (data sources) that may have specified Alert assigned or not assigned

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

itemsArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "items": [
    { … }
  ]
}