1. Functions

widgetItemClick

Version:
TypeFunction
Import path@sitecore-cloudsdk/search/server

Sends a widget item click event.

Signature

export async function widgetItemClick(
  widgetItemClickEventParams: WidgetItemClickEventParams
): Promise<void>

Parameters

NameTypeDescription
widgetItemClickEventParamsWidgetItemClickEventParamsData for widget item click events.

Return value

Returns a promise.

Examples

Example 76. Running the widgetItemClick function

Note

To run this function, you have to first initialize the Cloud SDK.

See more examples and other data you can include in the event.

Here's an example of how to use the widgetItemClick function:

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

:::

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