Get Alert Search Suggestions

GET {{cb_url}}/api/alerts/v7/orgs/{{cb_org_key}}/alerts/search_suggestions?query=devi&count=5

Provides recommendations on fields to search on based on the query provided as a query parameter.

RBAC Permissions Required

Permission (.notation name)Operation(s)
org.alertsREAD

Response Schema

{
  "suggestions": [
    {
      "term": "<string>"
    },
    {
      "term": "<string>"
    }
  ]
}

See complete documentation on the Developer Network -Alerts API

Request Params

KeyDatatypeRequiredDescription
querystring(Required) The query string for which you want completion suggestions.
countnumberThe number of suggestions to return

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;suggestions&quot;:[{&quot;term&quot;:&quot;device_id&quot;},{&quot;term&quot;:&quot;device_os&quot;},{&quot;term&quot;:&quot;device_name&quot;},{&quot;term&quot;:&quot;device_uem_id&quot;},{&quot;term&quot;:&quot;device_policy&quot;}]}