SuggestionFilterEventParams

Version: 0.6

Type	Interface
Extended by	FacetFilterEventParamsRangeFacetFilterEventParams
Import path	@sitecore-cloudsdk/search/server

Data common to search suggestions and facets. Part of the WidgetSuggestionClickEventParams data used when capturing suggestion click events.

Signature

export interface SuggestionFilterEventParams {
  name: string;
  title: string;
  displayName: string;
  value: string;
  valuePosition: number;
}

Name	Type	Description	Value
name	string	Required.Configured in Sitecore Search.For suggestions: the name of the suggestion block the site visitor interacts with.For facets: the name of the facet block the site visitor interacts with.	"makeup_product_suggestions""sizes_facet"
title	string	Required.For suggestions: the display title of the search suggestion block in the user interface.For facets: the display title of the facet block in the user interface.	"Suggestions""Available sizes"
displayName	string	Required.For suggestions: the name of the individual search suggestion in the user interface.For facets: the facet values in the user interface.	Suggestions:"red sandalwood""red algae""raspberry seed oil""beetroot extract""pomegranate extract"Facets:"S""M""XL"
value	string	Required.For suggestions: the value of the individual search suggestion in the user interface.For facets: the facet ID or the facet value.	Suggestions:"the antioxidant skin care ingredient you haven't tried yet""soothing and hydrating properties""used for its warming and stimulating effects"Facets:"facet_size_s""facet_size_m""facet_size_xl"
valuePosition	integer	Required.For suggestions: the position of the value in the search suggestion block.For facets: the position of the value in the facet block.	3

If you have suggestions for improving this article, let us know!