Skip to main content
Users
Changelog
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
  • Data lake export service
  • Data entities reference
  • Events

Events

The following table includes some of the attributes that are available in the events entity.

Your organization will have additional attributes.

Attribute

Description

Type

Example

meta_ref

The unique event reference.

string

"26c0ae4a-18ec-4105-8fbf-e2ed8c88a4c9"

bxt

A collection of name-value pair attributes that store various event data points. This attribute is owned and maintained by Sitecore. See the following table for a list of fields stored in the bxt attribute.

map

{[email protected], firstName=Charlie, language=EN}

core_channel

The channel on which the event was raised.

string

"WEB", "MOBILE_WEB", "MOBILE_APP"

core_currency_code

The organization’s currency code associated with the event.

3 letter ISO 4217

"EUR", "NZD", "USD"

core_language

The language of the user session.

string (2 letter ISO 639 language code)

"EN", "FR", "DE"

core_page

The webpage where the event was captured.

string

"trending_styles"

core_point_of_sale

The point of sale associated with the event. The point of sale is preconfigured by your organization.

string

"myretailsite.com", "bestretailsite.co.uk"

flow_execution_created_at

The date and time when the flow executed. The value for this attribute is only present for TRACKING events.

ISO 8601 Date/Time UTC

"2020-10-04T23:30:40.516Z"

flow_execution_dm_ref

The unique reference of the decision model associated with the flow. The value for this attribute is only present for TRACKING events.

string

"9810c713-0bc6-4349-8323-00d408047764"

flow_execution_dm_variant_ref

The unique reference of the decision model variant associated with the flow. The value for this attribute is only present for TRACKING events.

string

"c682b6b6-934b-415b-bc46-ce6184809156"

flow_execution_flow_ref

The unique reference of the flow. The value for this attribute is only present for TRACKING events.

string

"dd7e9c6c-b5bf-4204-8cc5-3c8380a4e993"

flow_execution_flow_variant_ref

The unique reference of the flow variant. The value for this attribute is only present for TRACKING events.

string

"25f46901-bc51-45e8-b587-148aecf1e48f"

flow_execution_guest_ref

The unique reference of the guest exposed to the flow. The value for this attribute is only present for TRACKING events.

string

"9d94ee11-7043-4b71-980c-a777d00a7b46"

flow_execution_latency

The latency of the flow execution expressed in milliseconds. The value for this attribute is only present for TRACKING events.

integer

1000

flow_execution_ref

The unique reference of the flow execution. The value for this attribute is only present for TRACKING events.

string

"5fde16f9-398e-4c11-b2d4-9ce3863bd7a1"

flow_execution_status

The flow execution success status. The value for this attribute is only present for TRACKING events.

string

"SUCCESS", "ERROR"

meta_browser_ref

The unique browser ID generated by Sitecore CDP. This is used for guest identification.

string

"405bbc9f-bb43-451d-98e5-4fa899ce6a75"

meta_client_key

The unique client reference that identifies your organization.

string

"mhbWwbHYfhpheu86hp60oR76S4jQMmZr"

meta_created_at

Date and time when the event record was created in Sitecore CDP.

ISO 8601 Date/Time UTC

"2024-01-01T16:17:16.000Z"

meta_created_at_date

Date when the event record was created in Sitecore CDP.

ISO 8601 Date

"2024-01-01"

meta_session_ref

The unique reference of the session in which the event was raised.

string

"e94e4ac3-078e-53f6-b60b-e4626d6348bc"

session_data

A collection of name value pair attributes that store your organization's custom data in the session associated with this event.

map <string, string>

{a=alpha, b=beta}

type

The event type.

string

"IDENTITY", "VIEW", "TRACKING"

ext

A collection of name value pair attributes that store your organization's custom event data.

map <string, string>

{percentageDiscount=17.5}

raw_json

The overall order representation as raw JSON.

JSON string

N/A

The following table describes the properties stored in the bxt map field. Different properties might be stored for different event types and might vary depending on your industry. For example, an IDENTITY event includes identifying information about the guest, while an ADD event includes details of the added product.

Attribute

Description

Type

Example

adults

For flight events, the number of adult passengers included in the event.

integer

1

category

For TRACKING events, the status of the event. Possible values are EXECUTED and FAILED.

string

"EXECUTED"

children

For flight events, the number of child passengers included in the event.

integer

1

dateOfBirth

The date of birth of the guest included in the event,

timestamp

1990-01-01T00:00

destination

For flight events, the destination specified in the event.

string

"MIL"

end

For flight events, the end time of the trip included in the event.

timestamp

2024-09-18T00: 00

email

The email address included in the event.

string

"[email protected]"

firstName

The first name of the guest included in the event.

string

"Alexis"

flightType

For flight events, the type of flight.

string

"RT"

gender

The gender of the guest included in the event.

string

"female"

infants

For flight events, the number of infant passengers included in the event.

integer

1

language

The language of the event.

string

"EN"

lastName

The last name of the guest included in the event.

string

"Rose"

origin

For flight events, the destination specified in the event.

string

"LHR"

paymentType

The payment method.

string

"CARD"

product

Details of the product included in the event.

map
RequestResponse
{
    "currency": "EUR",
    "destination": "IOM",
    "flight_type": "RT",
    "item_id": "LHR-IOM_ADT",
    "name": "LHR-IOM LOW",
    "origin": "LHR",
    "pax_type": "ADT",
    "price": 13.29,
    "quantity": 1,
    "type": "FLIGHT",
    "sku": "LHR-IOM|LOW"
}

productType

The product type included in the event.

string

"FLIGHT"

productName

The product name included in the event.

string

"mortgage"

referenceId

A 6-character string that references the orders entity.

string

"LF2J9D"

start

For flight events, the start time of the trip included in the event.

timestamp

2024-09-12T00: 00

status

The status of the event.

string

"PURCHASED"

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2024 Sitecore