POST /{environment}/searches/requests Copy page Copy link View Markdown Description Request search results scoped to a specific environment. Parameters Type Name Description Schema Path environment required The environment for which the request is made. string Body body required Search payload. SearchRequest Responses HTTP Code Description Schema 200 OK SearchResults Consumes application/json 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 Histories Map of custom histories that describe past user interactions. Name Description Schema <history_name> optional Array of recent events used for personalization. < HistoryItem > array HistoryItem Single interaction tuple used inside histories. Name Description Schema id required Identifier of the entity referenced by the event. string timestamp optional Unix timestamp (seconds). integer item_type optional Type of the entity (e.g., item, article, category). string reconsumable optional Whether the entity can be recommended again. boolean SearchRequest Specification of a search request body. Name Description Schema autocorrect optional Whether the query should be autocorrected (default: true). boolean filter_by optional Filters that limit which items can appear. Filter group_by optional Fields used to split results into multiple lists (default: []). < string > array limit optional Number of items returned per list (default: 4). integer list_size optional Number of items cached per list for later retrieval (default: 100). integer num_lists optional Number of lists requested (default: 4). integer q required The search query typed by the user. string page_type required Page or surface for which the request is made. string channel optional Channel identifier (e.g., web, iOS, Android). string user_id optional Logged-in user identifier. string device_id required Identifier for anonymous users or devices. string histories optional Behavioral histories that improve personalization. Histories SearchResults Response returned by the search endpoints. Name Description Schema auto_suggest optional Alternative query if autocorrect was triggered. string lists required Grouped search results. < List > array num_lists required Number of lists that were requested. integer perfect_match optional Exact match for the query, if available. Item request_id required Identifier of the request to log alongside events. string user_group optional Experiment group the user belongs to. string