Functions

pageView

Version:


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

Sends a VIEW event.

Signature

export async function pageView<NextRequest>(
  request: NextRequest,
  pageViewData?: PageViewData
): Promise<EPResponse | null>

Parameters

Name	Type	Description
`request`	`NextRequest`	Required. The HTTP request.
`pageViewData`	`PageViewData`	Optional. Data for `VIEW` events.

Return value

Returns a promise.

Examples

Example 46. Running the pageView 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 pageView function:

import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";
import { CloudSDK } from "@sitecore-cloudsdk/core/server";
import { pageView } from "@sitecore-cloudsdk/events/server";

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

  // Initialize the SDK and the package...

  // Send event:
  const pageViewResponse = await pageView(request);
  console.log("Sent VIEW event.", pageViewResponse);

  return response;
};

:::

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