GET /{environment}/searches/completions Copy page Copy link View Markdown Description Request completions for a partially entered query. Parameters Type Name Description Schema Path environment required The environment for which the request is made. string Query q required The query term to complete. string Query user_id optional Identifier of the logged-in user. string Query device_id optional Identifier for an anonymous user or device. string Query request_id optional Client-supplied identifier for correlating requests. string Query page_type optional Contextual page type for the query. string Responses HTTP Code Description Schema 200 OK Completion Produces application/json Item One content item returned by the Search API. Name Description Schema information_field required Optional metadata field configured per customer. string item_id required Identifier of the item in your catalog. string type required Document type of the returned object. string List Represents a grouped subset of search results. Name Description Schema grouped_by optional Values of the group_by keys shared by every item in the list. < string > array items optional Items contained in this list. < Item > array limit optional Number of items returned in this list. integer list_key optional Identifier that lets you re-fetch remaining items. string list_name optional Server-generated name of the list. string list_size optional Total number of cached items for this list. integer Filter Key-value filters applied to search requests. Name Description Schema <field> optional Field name/value pairs that determine which items are allowed. Configured per customer. string CompletionRequest Body accepted by the advanced completions endpoint. Name Description Schema fuzziness optional Maximum edit distance when matching queries (default: 0). integer filter_by optional Filters applied before generating completions. Filter q optional Partial query string. string user_id optional User identifier. string device_id optional Device identifier. string histories optional Interaction histories used to personalize results. Histories Completion Payload returned by the completions endpoints. Name Description Schema completions required List of suggested terms. < Item > array request_id required Identifier of the completion request. integer user_group optional Experiment group the user belongs to. string