Widget item click events

Events

Tracking
Events
Widget item click events

Version:

The widget item click event tracks when the site visitor clicks a search result in your app. Tracking which results get clicked helps improve search recommendations by, for example, displaying recently viewed or popular products to the site visitor.

You can send widget item click events by using the widgetItemClick function and passing it the widget item click event data object.

The widget item click event data object represents all the required and optional data about the event.

This is the object where you provide data about the event. All this data is sent to Sitecore Search, so make sure to provide the correct data depending on your organization's requirements. Construct the object in the following way:

Provide the ID of the widget ID of the widget that was clicked, data about the index document that was clicked, and the URI where the event triggered.
Optionally, you can provide data such as the channel and the language of the page where the event triggered.

Examples

Tip

During development, use your web browser's developer tools to check the payload containing all the event data that is sent to Sitecore.

Example 10. Sending a widget item click event

Here's an example event data object for a widget item click event. The object contains all the required and some optional event data. You can send this event by passing the object to the widgetItemClick function:

Browser module

import { widgetItemClick } from "@sitecore-cloudsdk/search/browser";
import type { WidgetItemClickEventParams } from "@sitecore-cloudsdk/search/browser";

const eventParams: WidgetItemClickEventParams = {
  entity: {
    entity: "product",
    id: "1"
  },
  pathname: "/page",
  widgetId: "rfkid_7",
  itemPosition: 1,
  request: {
    keyword: "green",
    numResults: 3,
    totalResults: 3,
    numRequested: 10
  },
  page: "sample-page"
};

widgetItemClick(eventParams);

Server module

import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";
import { CloudSDK } from "@sitecore-cloudsdk/core/server";
import { widgetItemClick } from "@sitecore-cloudsdk/search/server";
import type { WidgetItemClickEventParams } from "@sitecore-cloudsdk/search/server";

export default async function middleware(request: NextRequest) {
  const response = NextResponse.next();

  // Initialize the SDK and the package...

  // Send event:
  const eventData: WidgetItemClickEventParams = {
    entity: {
      entity: "product",
      id: "1"
    },
    pathname: "/page",
    widgetId: "rfkid_7",
    itemPosition: 1,
    request: {
      keyword: "green",
      numResults: 3,
      totalResults: 3,
      numRequested: 10
    },
    page: "sample-page"
  };

  const widgetItemClickResponse = await widgetItemClick(request, eventData);
  console.log("Sent widget item click event.", widgetItemClickResponse);

  return response;
};

For this widget item click event data object, the following payload is sent to Sitecore:

{
  "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
  "client_key": "",
  "language": "EN",
  "page": "sample-page",
  "pos": "",
  "requested_at": "2026-01-13T11:31:03.467Z",
  "sc_search": {
    "data": {
      "action_cause": "entity",
      "value": {
        "context": {
          "page": {
            "uri": "/page"
          }
        },
        "entities": [
          {
            "entity_type": "product",
            "id": "810565084"
          }
        ],
        "index": 1,
        "request": {
          "keyword": "green",
          "num_requested": 10,
          "num_results": 3,
          "total_results": 3
        },
        "rfk_id": "rfkid_7"
      }
    },
    "metadata": {
      "ut_api_version": "1.0"
    }
  },
  "type": "SC_SEARCH_WIDGET_CLICK"
}

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