Retrieve and Apply Facets

facets are attribute categories for records that customers can use to further filter results for example, if a customer searches for shirts , the available facets might include size, color, or material type refer to the facets section of search results customizations as well as manage facets for category pages in the monetate knowledge base for more information if a customer initiates a search on your site without typing anything into the search bar, then personalized search still returns results based on the settings you've configured for personalized site search or personalized category pages , as applicable, in the monetate platform additionally, personalized search displays all the indexed facets from the mapped product catalog, excluding any that you've removed using the settings you've configured in the monetate platform within a personalized search api request, you can both retrieve applicable facets to display to customers and apply facets to filter results retrieving facets retrieving facets is a computationally expensive operation for best performance, you should minimize the number of times you retrieve them for example, if you're paginating search results, retrieve facets only on the first query to retrieve facets in a personalized search api request, add the filterstoreturn object with its enabled key set to true use the include and exclude arrays to define which filters you want and do not want returned, respectively you must contact your dedicated customer success manager (csm) if you want to use a rating filter ("key" "rating") in the request the facets appear on your site as filters that the customer can apply to further narrow the search results retrieving the price facet personalized search treats the price facet differently from other facets, so displaying a price filter for customers to sort results does not involve passing price in the include array instead, you must include in the request the rangefiltersettings object with "monetate price" as the value for key see the definition of the rangefiltersettings object in the retrieve and apply facets docid\ epxtjiessh4 dsis 3wa1 reference for more information the example request and response in the retrieve and apply facets docid\ epxtjiessh4 dsis 3wa1 contain the key value pairs for the default price facet format, which presents customers with a selectable list of price ranges the following example request and response contain the key value pairs for the alternative format, a slider with minimum and maximum values that personalized search automatically sets based on the values of the relevant attribute in the mapped product catalog example request to retrieve price facet in slider format { "searchtoken" "monetate 156925593843210765", "recordqueries" \[ { "filters" { "filterstoreturn" { "enabled" true, "include" \[ "brand", "size" ] "options" { "order" "index", "limit" 5 }, "rangefiltersettings" \[ { "key" "monetate price", "minmax" true } ] } }, "id" "productsearch", "typeofrequest" "search", "settings" { "query" { "term" "short" }, "limit" 0, "typeofrecords" \[ "monetate product" ], "fields" \[ "id", "name" ] } } ] } response { "queryresults" \[ { "id" "productsearch", "meta" { "qtime" 17, "noofresults" 0, "totalresultsfound" 104, "typeofsearch" "wildcard and", "offset" 0, "debugginginformation" {}, "notificationcode" 1, "searchedterm" "short", "searchtoken" "monetate 156925593843210765", "ispersonalised" false }, "records" \[], "filters" \[ { "key" "category", "label" "category", "type" "options", "options" \[ { "count" 3, "name" "capri", "value" "capri", "selected" false }, { "count" 3, "name" "hoodies", "value" "hoodies", "selected" false }, { "count" 3, "name" "hoodies & sweatshirts", "value" "hoodies & sweatshirts", "selected" false }, { "count" 3, "name" "pants", "value" "pants", "selected" false }, { "count" 68, "name" "shorts", "value" "shorts", "selected" false } ] }, { "key" "size", "label" "size", "type" "options", "options" \[ { "count" 35, "name" "large", "value" "large", "selected" false }, { "count" 35, "name" "medium", "value" "medium", "selected" false }, { "count" 34, "name" "small", "value" "small", "selected" false } ] }, { "key" "brand", "label" "brand", "type" "options", "options" \[ { "count" 28, "name" "kre", "value" "kre", "selected" false }, { "count" 1, "name" "kre new", "value" "kre new", "selected" false }, { "count" 45, "name" "ksd", "value" "ksd", "selected" false }, { "count" 30, "name" "mnh", "value" "mnh", "selected" false } ] }, { "key" "monetate price", "label" "monetate price", "type" "slider", "min" "20", "max" "57", "start" null, "end" null } ] } ] } furthermore, because of the way personalized search returns a price based facet, you must include in your site's code some method to change the returned facet label, monetate price , into the label you want your customers to see in the following javascript example, the const keyword declares the constant value for heading with a means of removing monetate from the returned facet label monetate price example code to revise the monetate price label const heading = facet label replace(monetate /i, ""); the label that you want displayed for a price based facet is entirely up to you and must be part of your site's code applying facets applying facets to a query filters the results based on the selected facets and values run this query after a customer selects the facets they want to filter by apply facets in a query by using the applyfilters object if the customer selects only one value of only one facet, then personalized search ensures that all the returned records contain the facet attribute with the customer selected value however, if the customer selects multiple values for one facet, then the boolean key singleselect of the applyfilters object determines how personalized search applies them when singleselect is true , then a record must contain all the selected values to be included in the response when singleselect is false , then a record needs only to contain one of the selected values to be included in the response if constraints are added for multiple facets and singleselect is false , then a record must have at least one value from each of the filter conditions provided