---
title: "Preview search widget events"
slug: "preview-search-widget-events"
abstract: "Describes the entity payload used for tracking interactions with an entity."
---
# Preview search widget events

Sitecore Search JS SDK for React offers the following events to track interaction with the preview search widget.

> [!note]
> All attributes are optional unless indicated otherwise.

## trackPreviewSearchClickEvent

Tracks the clicks on an entity in the preview search container.

> [!note]
> Fire this event only if you are not using Search UI components.

| Name | Type | Description |
| --- | --- | --- |
| `rfkid` | string | Required.<br><br>Identifies the widget being tracked. |
| `entity` | string | Required.<br><br>Type of entity.<br><br>Example: `content` |
| `payload` | `PreviewSearchPayload` | Required.<br><br>Payload dispatched with the event. |

### PreviewSearchPayload

Payload dispatched with `trackPreviewSearchClickEvent`.

| Name | Type | Description |
| --- | --- | --- |
| `items` | array< `EntityPayload` > | Required.<br><br>Clicked entity. |
| `index` | number | Required.<br><br>The index of the clicked entity. |
| `keyword` | string | Phrase searched. |
| `advancedQueryText` | string | Query search expression to narrow the search.<br><br>Example: `filetype:pdf` |
| `modifiedKeyword` | string | Modified keyword as returned in the results. |
| `numResults` | number | Maximum number of results to retrieve. |
| `totalResults` | number | Total number of results identified by the search |
| `pageSize` | number | Maximum number of results that appear on one webpage. |
| `pageNumber` | number | The number of the page hosting the widget after the results have been paginated using `pageSize`, |
| `redirectUrl` | string | URL of the page the search redirects to. |

#### EntityPayload

This payload describes an entity. Use this payload type in all events when you want to track interaction with an entity.

| Name | Type | Description |
| --- | --- | --- |
| *id* | number | Required.<br><br>ID of the entity. |
| *entityType* | string | Required.<br><br>Name of the entity. |
| *url* | string | URL of the entity page. Typically the detail page of the entity.<br><br>When not supplied, the SDK uses the URL of the page. |
| *sourceId* | string | ID of the source of the entity, as assigned by the connector. |

## trackPreviewSearchSuggestionClickEvent

Tracks the clicks on a keyphrase, category, or suggestion in the preview search container.

> [!note]
> Fire this event only if you are not using Search UI components.

| Name | Type | Description |
| --- | --- | --- |
| `rfkid` | string | Required.<br><br>Identifies the widget being tracked. |
| `payload` | `PreviewSearchSuggestionPayload` | Required.<br><br>Payload dispatched with the event. |

### PreviewSearchSuggestionPayload

Payload dispatched with `trackPreviewSearchSuggestionClickEvent`.

| Name | Type | Description |
| --- | --- | --- |
| `filters` | array< `FilterPayload` > | Required.<br><br>Clicked entity. |
| `keyword` | string | Phrase searched. |
| `advancedQueryText` | string | Query search expression to narrow the search.<br><br>Example: `filetype:pdf` |
| `modifiedKeyword` | string | Modified keyword as returned in the results. |
| `numResults` | number | Maximum number of results to retrieve. |
| `totalResults` | number | Total number of results identified by the search |
| `pageSize` | number | Maximum number of results that appear on one webpage. |
| `pageNumber` | number | The number of the page hosting the widget after the results have been paginated using `pageSize`, |
| `redirectUrl` | string | URL of the page the search redirects to. |

#### FilterPayload

Payload describes a filter.

| Name | Type | Description |
| --- | --- | --- |
| `name` | string | Required.<br><br>Name of the suggester created in Sitecore Search. |
| `value` | string | Value of the suggestion clicked. |
| `title` | string | UI title of suggester name. |
| `displayName` | string | Display name of suggestion clicked. |
| `uri` | string | URL of the suggestion filter, if available. |