Data entities reference
Important
Feature availability is part of a phased rollout. Your organization may not see this functionality yet. It will become available when your environment is included in the rollout.
This page describes the data entities available through the data lake export service, including their attributes and types. Use this reference when building queries, reports, or integrations against the exported data.
Entity relationship diagram
The following diagram shows the relationships between the data lake export service data entities.
Data entities reference
The following tables describe the data entities and their attributes as they appear in the exported data.
Profile
| Name | Type | Description | Example |
|---|---|---|---|
| id | string | Unique identifier for the profile, system generated. | "123e4567-e89b-12d3-a456-426614174000" |
| createdAt | timestamp | Timestamp indicating when the profile was initially created, system generated. | "2020-09-08T16:17:16.000Z" |
| modifiedAt | timestamp | Timestamp indicating the last time the profile was updated, system generated. | "2020-09-08T16:17:16.000Z" |
| lastSeenAt | timestamp | Timestamp indicating when the profile was last seen, system generated. | "2020-09-08T16:17:16.000Z" |
| type | string | Specifies the type of profile, which can be either identified or visitor. | "identified" |
| contact | object | Contains the contact information associated with the profile. | See Profile.contact |
| identifiers | array | Collection of identifiers associated with the profile, such as email or phone number. | [ { "provider": "email", "id": "[email protected]" } ] See Profile.identifiers |
| clientIds | array | List of user IDs associated with the profile. | "f3a9c2e4-7b8d-4c2a-9f1e-8a6d3b2c9e1a" |
| extensions | map | Custom guest attributes. | See Profile.extensions |
| traits | object | Free-form structure to hold various traits related to the profile and session. | See Profile.traits |
| audiences | object | Information regarding the segments or audiences the profile belongs to. | See Profile.audiences |
Profile.contact
| Name | Type | Description | Example |
|---|---|---|---|
| firstName | string | The individual's first name, which must not be empty. (1–500 characters) | "John" |
| lastName | string | The individual's last name. (1–500 characters) | "Smith" |
| string | A valid email address format, which includes a local part, an "@" symbol, and a domain. | "[email protected]" | |
| dateOfBirth | date | The date of birth formatted in ISO 8601 standard, representing the year, month, and day. | "1995-01-01" |
gender | string | The gender of the individual. Free text is accepted, but one of the suggested values is recommended. | Suggested: male | female | unknown | other (1–100 characters) |
| language | string | The language code represented in ISO 639-1 format, using two uppercase letters. | "EN" |
title | string | A title for the individual, which can be free text or one of the specified enumerated values. | Suggested: "Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr" (1–100 characters) |
| phoneNumbers | map | A structured representation of various phone numbers, including home, work, and mobile. | See Profile.contact.phoneNumbers |
| address | object | A structured representation of a physical location, including street, city, state, and postal code. | See Profile.contact.address |
Profile.contact.address
| Name | Type | Description | Example |
|---|---|---|---|
| street | string | The street address. (1–500 characters) | "12 Baker Street" |
| city | string | The name of the city. (1–500 characters) | "Madrid" |
| state | string | The name of the state or region. (1–500 characters) | "Colorado" |
| postCode | string | The postal code, formatted according to the country. (1–500 characters) | "AB 123" |
| country | string | The country code, required if address is present. | "ES" |
Profile.contact.phoneNumbers
- Recommended to use E.164 for interoperability or document your local pattern.
- Open map, values can be set by the customer. See samples below.
| Name | Type | Description | Example |
|---|---|---|---|
| home | string | Home phone number in E.164 format or can be empty. | "+34911222333" |
| work | string | Work phone number in E.164 format or can be empty. | "+34914445566" |
| mobile | string | Mobile phone number in E.164 format or can be empty. | "+353861234567" |
Profile.identifiers
| Name | Type | Description | Example |
|---|---|---|---|
| provider | string | Specifies the provider of where the identifier came from. | "email" |
| id | string | The actual identifier value, formatted according to the specified provider. | "[email protected]" |
Profile.traits
| Name | Type | Description | Example |
|---|---|---|---|
| affinities | map | System generated affinity score based on page view. | See Profile.traits.affinities |
Profile.traits.affinities
- Stores customer-defined affinity signals in a nested map structure.
- Group names and value names are dynamic and customer-defined. Only the leaf object has fixed schema fields.
- First-level key = affinity group name (example: brand, category, productType). Second-level key = affinity value inside that group (example: adidas, running, shoes). Leaf object = affinityValue with fixed fields: views, score, lastViewAt.
| Name | Type | Description | Example |
|---|---|---|---|
| affinityGroup | string key | Dynamic top-level affinity group. | brand |
| affinityValueKey | string key | Dynamic value key under a group. | adidas |
| affinityValue | object | Fixed leaf object for one affinity value. | { views, score, lastViewAt } |
| Name | Type | Description | Example |
|---|---|---|---|
| views | integer | Number of views for this affinity value. | 25 |
| score | number | Affinity score for this value. | 0.95 |
| lastViewAt | timestamp | Last viewed or updated timestamp (ISO-8601 UTC). | "2026-05-20T14:22:31Z" |
Profile.audiences
| Name | Type | Description | Example |
|---|---|---|---|
| segmentMembership | array | Information regarding the segments or audiences the profile belongs to. | [ "segment1", "segment2" ] |
Profile.extensions
- General-purpose extensible attributes (business-specific). Defined by customers to meet their business needs.
| Name | Type | Description | Example |
|---|---|---|---|
| attribute | string, boolean, number, list, object | One or many name/value pair attributes for custom data. | [ "segment1", "segment2" ] |
Session
| Name | Type | Description | Example |
|---|---|---|---|
| id | string | Unique identifier for the session, system generated. | "123e4567-e89b-12d3-a456-426614174000" |
| profileId | string | Unique identifier for the profile, system generated. | "123e4567-e89b-12d3-a456-426614174000" |
| createdAt | timestamp | Timestamp when the session was created. | "2026-01-08T16:17:16.000Z" |
| createdAtIso | string | ISO-8601 representation of creation timestamp. Used as data partitioning. | "2026-01-08" |
| modifiedAt | timestamp | Timestamp when the session was last updated. | "2026-01-08T16:17:16.000Z" |
| clientId | string | User identifier associated with the profile. | "123e4567-e89b-12d3-a456-426614174000" |
| siteId | string | Site/application identifier. | "SpinAir" |
| channel | string | Channel through which the session occurred. | "Web" |
| status | string | Current status of the session. | "Closed" |
| language | string | The language of the site/page being viewed. Optional parameter that can be sent and derived from the events. | "EN" |
| clientDevice | object | Device information. | See Session.clientDevice |
| geolocation | object | Location information. | See Session.geolocation |
| utm | object | UTM attribution data. | See Session.utm |
| stats | object | Session statistics. | See Session.stats |
Session.clientDevice
| Name | Type | Description | Example |
|---|---|---|---|
| type | string | Device type. | "mobile" |
| software | string | Browser or application name. | "Chrome" |
| softwareVersion | string | Browser/application version. | "125.0" |
| operatingSystem | string | Operating system name. | "Android" |
| operatingSystemVersion | string | Operating system version. | "14" |
Session.geolocation
| Name | Type | Description | Example |
|---|---|---|---|
| city | string | Name of the city. | "Dublin" |
| continent | string | Continent code. | "EU" |
| country | string | Country code. | "IE" |
| region | string | Region or state name. | "Leinster" |
Session.utm
| Name | Type | Description | Example |
|---|---|---|---|
| source | string | UTM source. | "newsletter" |
| medium | string | UTM medium. | "email" |
| term | string | UTM term. | "productivity_tools" |
| content | string | UTM content descriptor. | "cta_button_top" |
| campaign | string | UTM campaign name. | "july_promo" |
Session.stats
| Name | Type | Description | Example |
|---|---|---|---|
| referer | string | The source from which the user arrived at the current page. | "google.com" |
| firstPage | string | First page visited. | "home" |
| lastPage | string | Last page visited. | "offers" |
| durationInSeconds | integer | Duration of session in seconds. | 18 |
| eventTypeCount | map | Event counts grouped by event type. | See Session.stats.eventTypeCount |
Session.stats.eventTypeCount
- Values can be set by the customer. See samples below.
| Field | Type | Description | Example |
|---|---|---|---|
| pageViews | number | Number of page views. | 5 |
| contentClick | number | Number of content clicks. | 11 |
| search | number | Number of searches. | 2 |
Events
| Name | Type | Description | Example |
|---|---|---|---|
| id | string | Unique identifier for the event, system generated. | "123e4567-e89b-12d3-a456-426614174000" |
| sessionId | string | Unique identifier for the session, system generated. | "123e4567-e89b-12d3-a456-426614174000" |
| createdAt | timestamp | Timestamp when the event was created. | "2026-05-20T14:22:31Z" |
| createdAtIso | string | ISO-8601 representation of creation timestamp. Used as data partitioning. | "2026-05-20" |
| modifiedAt | timestamp | Timestamp when the event was last updated. | "2026-05-20T14:30:00Z" |
| clientId | string | Client/device identifier associated with the profile. | "123e4567-e89b-12d3-a456-426614174000" |
| type | string | Predefined list for Sitecore events with customer-allowed custom events. | "pageView", "form", "identity" |
| siteId | string | Site/application identifier. | "Sitecore" |
| channel | string | Channel through which the session occurred. | "web", "mobile", "mobileApp", "offline" |
| name | string | The page/content associated to the event. Can be the full page name for a pageView or human readable name for content. | "homepage" |
| language | string | The language of the site/page being viewed. Optional parameter that can be sent. | "en-US" |
| customData | map | Additional parameters customers can add to the event for their own business needs. | See Events.customData |
| core | object | Sitecore defined key/value pairs, determined by the eventType. | See Events.core |
Events.core
| Name | Type | Description | Example |
|---|---|---|---|
| pageView | object | Page view event. | See Events.pageView |
| form | object | Form interaction event. | See Events.form |
| search | object | Search interaction event. | See Events.search |
| identity | object | Identity event. | See Events.identity |
Events.customData
- Values can be set by the customer. See samples below.
| Field | Type | Description | Sample |
|---|---|---|---|
attribute | string, boolean, number, list, object | One or many name/value pair attributes for custom data. | { "timeToComplete": 60, "formName": "Contact Us" } |
Events.pageView
| Name | Type | Description | Example |
|---|---|---|---|
| pageVariantId | string | Optional. ID of page variant. | "main-page-1" |
| currency | string | Optional. The alphabetic currency code of the currency the site visitor uses. If unset, this property will not be part of the payload. | "eur", "gbp", "usd" |
Events.form
| Name | Type | Description | Example |
|---|---|---|---|
| formId | string | ID of the form. | "form_123" |
| componentInstanceId | string | The UUID of the component that contains the XM Cloud form. Used for A/B/n testing. | "ac4109f5-9831-4abef-8005-647c70bfba01" |
| interactionType | string | Type of action. | "submitted", "viewed", "interacted" |
Events.search
| Name | Type | Description | Example |
|---|---|---|---|
| componentId | string | Required. The unique identifier of the widget. | "axfd3243252454" |
| componentInstanceId | string | The UUID of the component that contains the XM Cloud form. Used for A/B/n testing. | "ac4109f5-9831-4abef-8005-647c70bfba01" |
| interactionType | string | Type of action. | "viewed", "clicked" |
| keyword | string | The text the site visitor entered in the search field to perform a search. | "athletic sneakers" |
| nullResults | boolean | Shows if any results were returned for searched keyword. | false |
Events.identity
| Name | Type | Description | Example |
|---|---|---|---|
| currency | string | Optional. The alphabetic currency code of the currency the site visitor uses. If unset, this property will not be part of the payload. | "eur", "gbp", "usd" |
| contact | object | Contains the contact information associated with the profile. | See Events.identity.contact |
| identifiers | array | Collection of identifiers associated with the profile, such as email or phone number. | See Events.identity.identifiers |
Events.identity.contact
| Name | Type | Description | Example |
|---|---|---|---|
| firstName | string | The individual's first name, which must not be empty. (1–500 characters) | "John" |
| lastName | string | The individual's last name. (1–500 characters) | "Smith" |
| string | A valid email address format, which includes a local part, an "@" symbol, and a domain. | "[email protected]" | |
| dateOfBirth | date | The date of birth formatted in ISO 8601 standard, representing the year, month, and day. | "1995-01-01" |
| gender | string | The gender of the individual. We allow free text but suggest using one of the specified enumerated values. Suggested: male | female | unknown | other (1–100 characters) | "male" |
| language | string | The language code represented in ISO 639-1 format, using two uppercase letters. | "EN" |
| title | string | A title for the individual, which can be free text or one of the specified enumerated values. Suggested: "Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr" (1–100 characters) | "Mr" |
| phoneNumbers | map | A structured representation of various phone numbers, including home, work, and mobile. | See Events.identity.contact.phoneNumbers |
| address | object | A structured representation of a physical location, including street, city, state, and postal code. | See Events.identity.contact.address |
Events.identity.contact.address
| Name | Type | Description | Example |
|---|---|---|---|
| street | string | The street address. (1–500 characters) | "12 Baker Street" |
| city | string | The name of the city. (1–500 characters) | "Madrid" |
| state | string | The name of the state or region. (1–500 characters) | "Colorado" |
| postCode | string | The postal code, formatted according to the country. (1–500 characters) | "AB 123" |
| country | string | The country code, required if address is present. | "ES" |
Events.identity.contact.phoneNumbers
- Recommended to use E.164 for interoperability or document your local pattern.
- Open map, values can be set by the customer. See samples below.
| Name | Type | Description | Example |
|---|---|---|---|
| home | string | Home phone number in E.164 format or can be empty. | "+34911222333" |
| work | string | Work phone number in E.164 format or can be empty. | "+34914445566" |
| mobile | string | Mobile phone number in E.164 format or can be empty. | "+353861234567" |
Events.identity.identifiers
| Name | Type | Description | Example |
|---|---|---|---|
| provider | string | Specifies the provider of where the identifier came from. | "email" |
| id | string | The actual identifier value, formatted according to the specified provider. | "[email protected]" |
If you have suggestions for improving this article, let us know!