@sitecore-cloudsdk/search/server

EntityViewEventParams

Version:

Type	Interface
Import path	`@sitecore-cloudsdk/search/server`

Data for entity page view events.

Signature

export interface EntityViewEventParams {
  pathname: string;
  entity: SearchEventEntity;
  language?: string;
  page?: string;
  currency?: string;
  country?: string;
  referrer?: string;
}

Properties

Name	Type	Description	Value
`pathname`	`string`	Required. The URI of the webpage where the event triggered.	`"/products"`
`entity`	`SearchEventEntity`	Required. Data about the index documents index documents the site visitor interacts with in the search results.	N/A
`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"`
`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/"`

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