@sitecore-cloudsdk/search/server

ContextData

Version:

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

Details about the site visitor's search request, such as locale, location, device, and web browser information. Sitecore Search uses this data for personalizing search results.

Signature

export interface ContextData {
  locale?: LocaleData;
  page?: PageData;
  user?: UserData;
  store?: StoreData;
  campaign?: CampaignData;
  geo?: GeoData;
  browser?: BrowserData;
}

Properties

Name	Type	Description
`locale`	`LocaleData`	Optional. The country and language the webpage is being viewed in.
`page`	`PageData`	Optional. The URI the site visitor came to the current webpage from.
`user`	`UserData`	Optional. Data about the site visitor.
`store`	`StoreData`	Optional. Data about the online store where the site visitor made the search request. Typically used in Buy Online Pickup In Store retail strategies.
`campaign`	`CampaignData`	Optional. The UTM parameters in the URL of the webpage.
`geo`	`GeoData`	Optional. Geographical data about the search request.
`browser`	`BrowserData`	Optional. Data about the site visitor's web browser.

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