Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore CDP
Data privacy
Before you start sending data
Integrating with Sitecore CDP
Stream API
Batch API
REST APIs
Data lake export service
  • Sitecore CDP for developers
  • Stream API
  • Boxever JavaScript Library (legacy) reference
  • Functions
  • Boxever.addUTMParams(event)

Boxever.addUTMParams(event)

The addUTMParams() function adds every UTM parameter from the URL of the current webpage to the event object.

Parameters

Parameter

Type

Description

Note

event

object

All the event data.

N/A

Return value

none

Example

Here's an example of UTM parameters:

https://myretailsite.com?utm_source=newsletter&utm_medium=email&utm_campaign=summer_sale&utm_term=running+shoes

By default, the event object does not include UTM parameters. To add the UTM parameters to the event object, pass the event object to the addUTMParams() function:

RequestResponse
_boxeverq.push(() => {
    const viewEvent = {...};
    Boxever.addUTMParams(viewEvent); // pass the event object to addUTMParams()
    Boxever.eventCreate(
        viewEvent,
        () => {},
        "json"
    );
});

The event data that is sent to Sitecore CDP now includes all UTM parameters:

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

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2026 Sitecore