---
title: "ContextData"
slug: "cloud-sdk-search-contextdata-1539464"
abstract: "The ContextData interface represents details about the site visitor's search request, such as the site visitor's locale and location, device, and web browser information. Used for personalizing search results."
---
# ContextData

|     |     |
| --- | --- |
| 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

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

## Properties

| Name | Type | Description |
| --- | --- | --- |
| `locale` | [`LocaleData`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-localedata.html "LocaleData") | Optional.<br><br>The country and language the webpage is being viewed in. |
| `page` | [`PageData`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-pagedata.html "PageData") | Optional.<br><br>The URI the site visitor came to the current webpage from. |
| `user` | [`UserData`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-userdata.html "UserData") | Optional.<br><br>Data about the site visitor. |
| `store` | [`StoreData`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-storedata.html "StoreData") | Optional.<br><br>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`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-campaigndata.html "CampaignData") | Optional.<br><br>The [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters) in the URL of the webpage. |
| `geo` | [`GeoData`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-geodata.html "GeoData") | Optional.<br><br>Geographical data about the search request. |
| `browser` | [`BrowserData`](https://doc.sitecore.com/sdk/en/developers/005/cloud-sdk/cloud-sdk-reference/cloud-sdk-search/cloud-sdk-search-browser/interfaces/cloud-sdk-search-browserdata.html "BrowserData") | Optional.<br><br>Data about the site visitor's web browser. |