Engage.pageView(eventData[, extensionData])

Note

This is a client-side function used for implementing client-side tracking. If you want to implement server-side tracking instead, use the server-side functions.

The pageView() function sends a VIEW event. The VIEW event triggers every time your webpage loads. You should send a VIEW event from every webpage that you want to track on your website.

Parameter	Type	Description
`eventData`	object	All the event data.
`[extensionData]` optional	object	Custom data about an event. Maximum 50 custom attributes of your choice.

Parameter

Type

Description

eventData

object

All the event data.

[extensionData]

optional

object

Custom data about an event.

Maximum 50 custom attributes of your choice.

Here's an example of how to use the pageView() function. In a React app, call this function in an Effect Hook.

import { engage } from "./engage.js";
// ...

useEffect(() => {
  if (engage !== undefined) {
      sendPageViewEvent();
  };
}, []);

const sendPageViewEvent = async () => {
  const eventData = {
    channel: "WEB",
    currency: "EUR",
    pointOfSale: "myretailsite/ireland",
    language: "EN",
    page: "home",
    pageVariantId: "351"
  };

  const extensionData = {
    customKey: "customValue"
  };

  await engage.pageView(eventData, extensionData);
};

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