POST /{environment}/searches/completions Description Request completions in an environment-aware setup. Parameters Type Name Description Schema Path environment required The environment for which a request is made. string Body body required CompletionRequest Responses HTTP Code Description Schema 200 OK Completion Consumes application/json Produces application/json Item One content-item. Name Description Schema information_field required The Froomle API can be configured to return additional information fields (if present in the item information). Please contact your Froomle Solution Architect to set this up. string item_id required The identifier of the recommended item. string type required The document type of the object being returned. string List A list of limit items is returned. Potentially the list consists of list_size items in total, of which the next can be queried by passing the list_key to the /lists endpoint. Name Description Schema grouped_by optional Values of group_by-keys that are common among Items in a List. Default: [] < string > array items optional List of limit Items. limit is equal to the minimum of limit specified in the request and the number of recommendations found. < Item > array limit optional Number of Items returned integer list_key optional Bytestring identifier of the List string list_name optional Bytestring name of the list. Generated by Froomle. string list_size optional Total number of Items in this List (of which only limit Items are returned) integer Filter Filters to be specified in a Search to determine which Items should be allowed and which should not. Filters are key-value pairs of properties on an Item. Filters can be applied on any property of an Item given by the client. Name Description Schema <field> optional The Froomle Search API can be configured to allow for certain filters to be applied. Please contact your Froomle Solution Architect to set this up. string Histories Dict of additional customer-defined histories each having a maximum length of 50 tuples Type : < string, < HistoryItem > array > map HistoryItem Single event entity defined by at least an identifier Name Description Schema id required Identifier of the entity of the event, we support most entities that would appear in a detail_pageview, item_interaction, group_pageview or group_interaction. string item_type optional Type of the entity (e.g. item, article, video, category, group, …). These types are Froomle-defined, please consult your solutions architect for the correct type. string reconsumable optional True if the entity is allowed to appear in the generated recommendations boolean timestamp optional Unix timestamp (seconds since Jan 1st 1970 00:00:00) of the event integer CompletionRequest Request for Completions Name Description Schema device_id optional User Identifier string filter_by optional Filter fuzziness optional Give results for nearest correct query integer histories optional Histories q optional Part-word query string user_id optional User Identifier string Completion Completions based on Search query Name Description Schema completions required < Item > array request_id required integer user_group optional The group the user is assigned to. If users get the Froomle experience, this will always be "froomle". string version optional The version the user is assigned to. Used for AB testing purposes string