Get Search suggestions in a list format
GET {{baseUrl}}/api/searches/suggestions?key=Excepteur Lorem&count=4&isCrossCluster=false&fields=Excepteur Lorem
Use the stored results of the Search engine to return search suggestions and display them as a list.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
key | string | Value the search pattern is set to, which will be applied to the names of suggestions being searched. | |
count | number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
isCrossCluster | boolean | Perform search in all unique projects across the cluster, this parameter only takes affect for I-Server with cluster nodes. | |
fields | string | Comma separated top-level field whitelist. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of top-level response model. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token | |
X-MSTR-ProjectID | string | Project ID |
RESPONSES
status: OK
{"suggestions":["qui exercitation in","laborum aliqua sed quis"]}