Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
            • Settings object
                • VIEW event
                • IDENTITY event
                • ORDER_CHECKOUT event
                • ADD event
                • CONFIRM event
                • CHECKOUT event
                • PAYMENT event
                • CLEAR_CART event
                • SEARCH event
                • Custom event
            • Extension data object
        • Troubleshooting
        • Release notes
  1. Event data object
  1. Stream API
  2. Objects
  3. Event data object
  4. VIEW event

VIEW event

The event data object for a VIEW event must include all the required attributes for event data objects. No further attributes are required. The object can optionally include the following attributes:

Attribute

Type

Description

Example

pageVariantId

string

The ID of a personalized page variant.

"page_variant_3"

After you create this event data object, you can optionally extend this event using the extension data object. Then, you can send the event using the Engage.pageView() function.

Example 23. VIEW event

Here's an example of the event data object for a VIEW event.

const eventData = {
    channel: "WEB",
    currency: "EUR",
    pointOfSale: "myretailsite/ireland",
    language: "EN",
    page: "home",
    pageVariantId: "page_variant_3"
}


Example 24. VIEW event with UTM parameters

Here's an example of an event data object for a VIEW event that is sent to Sitecore CDP with UTM parameters included. By default, the VIEW event data object includes UTM parameters. You can exclude UTM parameters from the VIEW event data object by setting the value for includeUTMParameters to false in the settings object.

When a VIEW event triggers, the event data includes all the UTM parameters that are in the URL:

{ 
    { ... } 
    "utm_source":"newsletter",
    "utm_medium":"email",
    "utm_campaign":"summer_sale",
    "utm_term":"running shoes"
}


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

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use