COcommerceexperts
Suggest

Autocomplete the user input

Changed on

Runs a suggestion request on the data of a certain index.

get/suggest-api/v1/{indexname}/suggest

Request

  • Base URL
    http://suggest-service
  • URL
    http://suggest-service/suggest-api/v1/{indexname}/suggest
  • Auth
    HTTP basic

Path parameters

indexnamestring required

index name that should be searched for autocompletions

Query parameters

userQuerystring required

the simple raw query typed by the user

limitinteger

A optional limit for the suggestions

filterstring

Optional comma-separated list of filter values.

Response

successful found results

payloadobject

arbitrary payload attached to that suggestion. Default: null

phrasestring

The phrase that is suggested and/or used as suggestion label.

typestring

Optional type of that suggestion. Should be different for the different kind of suggested data. Default: 'keyword'

Example response

[
  {
    "type": "keyword, brand, category, product"
  }
]

Changes