v1
latestOpenAPI 3.0.32026-07-2659199427.5 KBGet typeahead suggestions
The GET /typeahead/suggestions request retrieves a list of typeahead suggestions.
A total of 5,000 suggestions are allowed in the following distribution:
-
Your organization can enter a maximum of 4,000 custom terms (included and excluded) in the Core Settings Typeahead user interface.
-
Every hour, a maximum of 1,000 of the terms entered most often in customer searches are added to the Included typeahead suggestions list.
Results are sorted alphabetically. Sort options are not currently available.
The optional prefix query parameter filters suggestions returned. For example, GET /typeahead/suggestions?prefix=El returns the suggestions that begin with the letters El.
The optional limit query parameter limits the maximum number of suggestions returned. For example, GET /typeahead/suggestions?limit=10 returns a maximum of 10 suggestions.
Query parameters
Optional parameter that filters suggestions returned. For example, GET /typeahead/suggestions?prefix=El returns the suggestions that begin with the letters El.
Optional parameter that limits the number of suggestions returned. For example, GET /typeahead/suggestions?limit=10 returns a maximum of 10 suggestions.
Headers
This is the unique embed token for the Lucidworks Platform typeahead instance, and is provided by Lucidworks. Each Typeahead instance has an embed token that is used for authentication.
application/json
Response
Suggestions retrieved successfully