@sitecore-cloudsdk/search/server

widgetView

Version:

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

Sends a widget view event.

Signature

export async function widgetView(
  widgetViewEventParams: WidgetViewEventParams
): Promise<void>

Parameters

Name	Type	Description
`widgetViewEventParams`	`WidgetViewEventParams`	Data for widget view events.

Return value

Returns a promise.

Examples

Example 75. Running the widgetView function

Next.js

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 widgetView function:

import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";
import { CloudSDK } from "@sitecore-cloudsdk/core/server";
import { widgetView } from "@sitecore-cloudsdk/search/server";
import type { WidgetViewEventParams } 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: WidgetViewEventParams = {
    request: {
      keyword: "green",
      numResults: 3,
      totalResults: 3,
      numRequested: 10
    },
    entities: [
      {
        entity: "product",
        id: "1"
      },
      {
        entity: "product",
        id: "2"
      },
      {
        entity: "product",
        id: "3"
      }
    ],
    pathname: "/page",
    widgetId: "rfkid_7"
  };

  const widgetViewResponse = await widgetView(request, eventData);
  console.log("Sent widget view event.", widgetViewResponse);

  return response;
}

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