Faceting

if you haven't gone through the prerequisites and the v2 structure, please have a look at overview docid\ czeodl0skcuv 18ipuplr it is important to note that retrieving filters is an expensive operation that can slow down your search experience for this reason, you may want to fetch filters once per unique query and cache them locally for example, when using pagination to retrieve records from subsequent pages, there is actually no need to fetch the filters again since these will not change from page to page the filters from klevu are always for the entire set of records for that query while searching for records, you can also request aggregations of the attribute values within the search results, so you can allow your customers to filter the results further for example, if the search query was "tops", you may also be interested to know all of the colors, sizes, and materials that these tops are available in to display them as selectable facets or filters there are two separate methods of working with filters with the klevu search api retrieving filters applicable to a search result applying one or more of those filters to a search query to apply a filter, you need to know the key of the relevant filter and the value of the relevant option, which should be submitted using the same format and case sensitivity as is returned by klevu retrieving facets the filterstoreturn object can be used for obtaining filters from the klevu search engine you can request all possible filters or only those matching certain criteria understanding response format params description key this is the unique identifier of the attribute for which options are being provided label this is the label or caption which you have associated with the attribute in the klevu merchant centre type the type of the filter will be either options, slider or rating for an options filter, its different options, eg red, blue, black, are provided for a slider filter, values such as minimum, maximum, start and end are provided in the response for a rating filter, its rating ranges from 1 to 5, where range is defined as below the rating range of 4 51 5 5 is considered the 5 rating the rating range of 3 51 4 5 is considered the 4 rating the rating range of 2 51 3 5 is considered the 3 rating the rating range of 1 51 2 5 is considered the 2 rating the rating less than 1 50 is considered 1 rating options for type options this will contain an array of different options available name the label or caption of the option, eg red, blue, black, etc value this is the unique identifier which should be used when applying a filter to search results count the number of records found with the current option in the current search results selected whether ot not the current option is already applied as a filtering condition on the search results min, max, start, end these values are provided only for the slider or range filters min, max these values are the minimum and maximum values found in the current result set this can be used to set the upper and lower limits of your slider start, end the start and end values are the filtering conditions already applied on the result set for this filter, or null if no filter has been applied applying facets the applyfilters object can be used for applying filter conditions so your customers can fine tune their results based on relevant attributes understanding response format if only one filter is applied with only value, klevu search ensures that all the records returned contain the relevant attribute with the specified value in the case where two or more values for the same filter are provided, the execution is dependent on the value of the singleselect parameter if it is set to true, the products returned must have both the values if it is set to false, the products returned must have at least one of the values if constraints are added for multiple filters and the value of the singleselect filter is false, the products returned must have at least one value from each of the filter conditions provided try it here!