1. @sitecore-cloudsdk/search/server

WidgetItemClickEventParams

Version:

Type

Interface

Import path

@sitecore-cloudsdk/search/server

Data for widget item click events.

Signature

export interface WidgetItemClickEventParams {
  request: SearchEventRequest;
  entity: SearchEventEntity;
  itemPosition: number;
  pathname: string;
  widgetId: string;
  language?: string;
  page?: string;
  channel?: string;
  currency?: string;
  country?: string;
  referrer?: string;
}

Properties

Name

Type

Description

Value

request

SearchEventRequest

Required.

Data common to search events.

N/A

entity

SearchEventEntity

Required.

Data about the index documents the site visitor interacts with in the search results.

  • "content"

  • "category"

  • "product"

  • "store"

  • "video"

itemPosition

integer

Required.

The index document's position in the search results.

4

pathname

string

Required.

The URI of the webpage where the event triggered.

"/products"

widgetId

string

Required.

The unique identifier of the widget.

"rfkid_7"

language

string

Optional.

The language the site visitor interacts with your brand in.

For example, if the site visitor selects the Japanese language in your app, the language is "JA".

Format: ISO 639.

If unset, this property will not be part of the payload.

  • "DE"

  • "EN"

  • "FR"

page

string

Optional.

The name of the webpage where the interaction with your brand takes place.

If unset, this property will not be part of the payload.

  • "Home Page"

  • "home"

  • "contact-us.html"

channel

string

Optional.

The touchpoint where the user interacts with your brand.

For example, for webpages, the channel is "WEB". For mobile app screens, the channel is "MOBILE_APP".

Format: uppercase.

If unset, this property will not be part of the payload.

Must be one of:

  • "AIRPORT_KIOSK"

  • "BRANCH"

  • "CALL_CENTER"

  • "EMAIL"

  • "GDS"

  • "KIOSK"

  • "MOBILE_APP"

  • "MOBILE_WEB"

  • "SMS"

  • "OFFLINE"

  • "OTA"

  • "OTHER"

  • "WEB"

currency

string

Optional.

The alphabetic currency code of the currency the site visitor uses in your app.

For example, if the site visitor selects Australian dollars as the currency, the currency is "AUD".

Format: uppercase ISO 4217.

If unset, this property will not be part of the payload.

  • "EUR"

  • "GBP"

  • "USD"

country

string

Optional.

The locale the site visitor interacts with your brand in. See also Sitecore Search locales and SitecoreAI site locales.

Format: ISO 3166 Alpha 2.

If unset, this property will not be part of the payload.

  • "DE"

  • "US"

  • "FR"

referrer

string

Optional.

The URI of the webpage that linked to the webpage where the event was captured.

If unset, this property will not be part of the payload.

"https://www.example.com/"

A JSON object that represents a single item in the content collection.

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