List Alert Filter Autocomplete Suggestions

POST 
/filter/alert/suggest

Returns available options for an alert filter key. Supports fuzzy autocomplete search. If you specify a query value in the request body parameters, the response includes only items that contain the query string.

Request

application/json; charset=UTF-8

Body

filterName stringrequired

Filter name

query string

Case-insensitive fuzzy search autocomplete filter. Includes only items that contain the query as a substring.

Responses

200

successful operation

*/*

Schema

Schema

completeParameters object[]
Array [
name string
Name
operator string
Possible values: [=]
Operator
value string
Value
]
links string

JSON query builder links

needsOffsetUpdate boolean

Needs offset update (for internal use)

offset int32

Offset within query

queryRemainder string

Query remainder

suggestions string[]

List of suggestions

translate boolean

Translate (for internal use)

valid boolean

Query is valid

Example (from schema)

{
  "completeParameters": [
    {
      "name": "string",
      "operator": "=",
      "value": "string"
    }
  ],
  "links": "string",
  "needsOffsetUpdate": true,
  "offset": 0,
  "queryRemainder": "string",
  "suggestions": [
    "string"
  ],
  "translate": true,
  "valid": true
}

Loading...