Skip to content
v3 API/
/
Search Alerts for assigni...

Search Alerts for assigning them to other items (audits, WJs etc)

Request

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

Page number, starts with 0

Default:0
sortBystring

Behaviour per type:

  • REPORT_METRIC: sort by name of data/report type corresponding to alert's metricType
Enum:"ALERT_NAME""REPORT_METRIC"
sortDescboolean

Controls sorting order

Default:false
Bodyapplication/json
targetItemobject

Item (audit/journey) alerts are assigned or not assigned to

searchstring, non-empty

When value is present it works as "alert name contains given substring" filter

labelsArray of integers, non-empty

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

isDefaultForNewDataSourcesboolean

Makes this alert selected by default in data-source (audit/WJ) creation UI. This is a user-specific flag.

POST
/v3/alerts/search/assignments
curl -i -X POST \
  'https://api.observepoint.com/v3/alerts/search/assignments?size=50&page=0&sortBy=ALERT_NAME&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "targetItem": {
      "itemType": "AUDIT",
      "itemId": 0,
      "isAssigned": true
    },
    "search": "string",
    "labels": [
      223
    ],
    "isDefaultForNewDataSources": true
  }'

Responses

Assignments

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

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