@sitecore-cloudsdk/search/browser

FacetFilterEventParams

Version:

Type	Interface
Extends	`SuggestionFilterEventParams`
Import path	`@sitecore-cloudsdk/search/browser`

Data for facets. Part of the WidgetFacetClickEventParams data used when capturing facet click events.

Signature

export interface FacetFilterEventParams extends SuggestionFilterEventParams {
  facetPosition: number;
}

Properties

Name	Type	Description	Value
`facetPosition`	`integer`	Required. The position of the facet block the site visitor interacts with. For suggestions: the position of the suggestion category (`title`) the site visitor interacts with, relative to other suggestion categories on the page. Set this value to `0` for the first suggestion category, to `1` for the second suggestion category, and so on. For example, a site visitor sees three suggestion categories at the top of a search results page: Trending, Most clicked, and Newest. If the site visitor clicks a suggestion within the second category, Most Clicked, pass `1`. For facets: the position of the facet block the site visitor interacts with, relative to other facet blocks on the page. Set this value to `0` for the first facet, to `1` for the second facet, and so on.	`3`

Name

Type

Description

Value

facetPosition

integer

Required.

The position of the facet block the site visitor interacts with.

For suggestions: the position of the suggestion category (title) the site visitor interacts with, relative to other suggestion categories on the page.

Set this value to 0 for the first suggestion category, to 1 for the second suggestion category, and so on.

For example, a site visitor sees three suggestion categories at the top of a search results page: Trending, Most clicked, and Newest. If the site visitor clicks a suggestion within the second category, Most Clicked, pass 1.

For facets: the position of the facet block the site visitor interacts with, relative to other facet blocks on the page.

Set this value to 0 for the first facet, to 1 for the second facet, and so on.

3

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