Autocomplete Search

POST 
/search/suggest

Returns the possible options—including expressions, values, and operators—to append to a partial RQL query.

Specifying a partial RQL query in the query parameter will result in a list of suggested options to append to your partial query. No other parameters are required.

Request

application/json; charset=UTF-8

Body

required

Search model

cloudType string

Possible values: [aws, azure, gcp, alibaba_cloud, oci]

Cloud Type

id string

Search ID

name string

Search Name

description string

Search Description

saved boolean

Search Exists

timeRange objectrequired

Model for TimeRangeConfig

type string

Possible values: [relative]

Time type

value object

Model for RelativeTimeDuration

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

amount int32

Number of time units

query stringrequired

RQL Query

default boolean

Responses

200

success

application/json; charset=UTF-8

Schema

Schema

valid boolean

Query is valid

offset int32

Offset within query

suggestions string[]

List of suggestions

translate boolean

Translate (for internal use)

needsOffsetUpdate boolean

Needs offset update (for internal use)

links string

JSON query builder links

Example (from schema)

{
  "valid": true,
  "offset": 0,
  "suggestions": [
    "string"
  ],
  "translate": true,
  "needsOffsetUpdate": true,
  "links": "string"
}

Loading...