Context parameters for conditions
The following sections detail the types of context parameters you can include when creating a condition.
We recommend you familiarize yourself with the types of parameters and types of parameters for conditions, as well as unsupported JavaScript functions, before you add any context parameters to conditions.
Guest parameters
The guest object contains parameters about the site visitor. When you use JavaScript in a custom condition, you can check for the presence of a value from the guest object. For example, you can check the site visitor's guest type, which is the level of identity Sitecore CDP has determined for the site visitor.
You can also include guest parameters that non-technical users can assign values for when applying a condition in an audience export. For example, the user can select which language the guest uses, as a condition for including the guest in the export.
To use parameters from the guest object in a condition, include the full path to the guest parameter in the JavaScript editor. The full path is provided in the Parameter column of this table:
| Parameter | Type | Description | Example |
|---|---|---|---|
guest.language | string | The language used by this guest, represented by 2 letters, in ISO 3166-1 alpha-2 format. | "EN" |
guest.email | string | The email address of the guest. | "[email protected]" |
guest.title | string | The title of the guest. | "Ms." |
guest.firstName | string | The first name of this guest. | "Dave" |
guest.lastName | string | The last name of this guest. | "Jones" |
guest.gender | string | The gender of this guest. | "unknown" |
guest.city | string | The city address of the guest. | "Dublin" |
guest.country | string | The country of this guest, represented by 2 letters, in ISO 3166-1 alpha-2 format. | "IE" |
guest.nationality | string | The nationality of the guest. | "Irish" |
guest.dateOfBirth | date | The date of birth of this guest. | 2001-02-15T00:00 |
guest.passportExpiry | date | The expiry date of the guest's passport. | 2023-08-01'T'00:00.000'Z |
guest.type | string | The level of identity obtained for the guest. | "customer" |
guest.firstSeen | date | The first time the guest interacted with your brand. | "2015-01-01T16:17.000Z" |
guest.lastSeen | date | The last time the guest interacted with your brand. | "2023-04-06T16:17.000Z" |
UTM and referrer parameters
When you use JavaScript in a custom condition, you can check for the presence of, for example, the site visitor's point of sale.
You can also include session parameters that non-technical users can assign values for when applying the condition in an audience export. For example, the user can select which UTM campaign is associated with the site visitor's URL as a condition for including the guest in the export.
To ensure Sitecore CDP returns the parameters when evaluating the condition, include this function in the JavaScript editor:
To use parameters in a condition, include the full path to the request parameter in the JavaScript editor. The full path is provided in the Parameter column of this table:
| Parameter | Type | Description | Example |
|---|---|---|---|
request.pointOfSale | string | The point of sale associated with the session. | "myretailsite/ireland" |
request.params.referrer | string | The referrer associated with the session. | "facebook.com" |
request.params.utm.campaign | string | The UTM campaign included in the visitor's current URL. | "content_promotion" |
request.params.utm.source | string | The UTM source included in the visitor's current URL. | "bing" |
request.params.utm.medium | string | The UTM medium included in the visitor's current URL. | "social" |
request.params.utm.content | string | The UTM content included in the visitor's current URL. | "call_to_action" |
Tenant parameters
The tenant object contains parameters from your organization's tenant settings that are set in the Company Information screen. When you use JavaScript in a custom condition, you can check for the presence of a value from the tenant object. For example, you can check if the tenant's currency is EUR.
The parameter values set in the Company Information screen and returned in the tenant object are not necessarily identical to the parameters that your organization sends to the Sitecore CDP APIs.
To use tenant parameters in a condition, include the full path to the tenant parameter in the JavaScript editor. The full path is provided in the Parameter column of this table:
| Parameter | Type | Description | Example |
|---|---|---|---|
tenant.configurations.dateFormat | string | The date format that displays on the Sitecore CDP UI. | "1985-12-24" |
tenant.configurations.name | string | The name of the tenant. | "My Retail Site" |
tenant.configurations.timeZone | string | The time zone of the tenant. | "Europe/Dublin" |
tenant.configurations.currency | string (uppercase ISO 4217) | The alphabetic currency code of the currency in which monetary values display in the Sitecore CDP UI. | "EUR" |
tenant.configurations.language | string | The primary language set for the tenant. | "en-gb" |
Entity parameters
When you use JavaScript in a custom condition, you can check for the presence of a value from the entity object.
To use entity parameters in a condition, include the full path to the entity parameter in the JavaScript editor. The full path is provided in the Parameter column of this table:
| Parameter | Type | Description | Example |
|---|---|---|---|
entity.ref | string | The UUID of the event. | "717732d5-ab8a-4506-8e56-90e71ee9e008" |
entity.createdAt | string | The time that Sitecore CDP received the event. | "2023-07-19T05:50.267Z" |
entity.modifiedAt | string | The time the event was modified. | "2023-07-20T05:50.267Z" |
entity.type | string | The event type. | "GUEST_CREATED", "ORDER_CREATED", "ORDER_UPDATED", "SESSION_CLOSED", "GUEST_MODIFIED_CUSTOM" |
entity.status | string | The status of the event. | "PROCESSED" |
entity.channel | string | The touchpoint where the user interacts with your brand. For example, for webpages, the channel is WEB. For mobile app screens, the channel is MOBILE_APP. |
|
entity.pointOfSale | string | The name of the point of sale where the interaction with your brand takes place. | "myretailsite/ireland" |
entity.browserRef | string | The unique browser reference. | "56860bff-94ba-4d84-aa37-2b5a83d5411b" |
entity.sessionRef | string | The unique session reference. | "a60e670f-52d6-5cd0-aec3-59de082e3953" |
entity.arbitraryData | object | A JSON object of custom data. | N/A |
entity.arbitraryData.language | string | The language of the user session. | "EN" |
entity.arbitraryData.page | string | The name of the webpage where the interaction with your brand takes place.This is a custom value of your choice. | "contact-us.html" |
entity.arbitraryData.currency | string | The alphabetic currency code of the currency the user is using in your app. | "EUR" |