Sessions
The following table includes some of the attributes that are available in the sessions entity.
Your organization will have additional attributes.
| Attribute | Description | Type | Example |
|---|---|---|---|
meta_ref | The unique session reference. | string | "a60e670f-52d6-5cd0-aec3-59de082e3953" |
bxt | A collection of name-value pair attributes that store various session 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 | {numSelects=0, numConfirms=0, numSearches=0, numCheckouts=0, cartType=BROWSED, language=EN} |
core_channel | The channel associated with the session. | string | "WEB", "MOBILE_WEB", "MOBILE_APP" |
core_currency_code | The organization’s currency code for the order associated with the session. | 3 letter ISO 4217 | "EUR", "NZD", "USD" |
core_duration | The duration of the session in minutes and seconds. | integer double | 44.55 |
core_started_at | The date and time when the session started. | ISO 8601 Date/Time UTC | "2026-10-04T22:30.516Z" |
core_ended_at | The date and time when the session ended. | ISO 8601 Date/Time UTC | "2026-10-04T23:15.516Z" |
core_point_of_sale | The point of sale associated with the session. The point of sale is preconfigured by your organization. | string | "myretailsite.com", "bestretailsite.co.uk" |
core_status | The status of the session. | string | "OPEN", "CLOSED" |
core_value | Monetary value of the order in original currency associated with session. Populated for sessions where an order was submitted. | integer double | 100.50 |
meta_client_key | The unique client reference that identifies your organization. | string | "mhbWwbHYfhpheu86hp60oR76S4jQMmZr" |
meta_created_at | Date and time when the session record was created in Sitecore CDP. | ISO 8601 Date/Time UTC | "2026-01-01T16:17.000Z" |
meta_created_at_date | Date when the session record was created in Sitecore CDP. | ISO 8601 Date | "2026-01-01" |
meta_flow_execution_ref | The unique reference of the experience or flow executed in the session. | string | "dd7e9c6c-b5bf-4204-8cc5-3c8380a4e993" |
meta_guest_ref | The unique ID of the guest associated with the session. | string | "9d94ee11-7043-4b71-980c-a777d00a7b46" |
meta_modified_at | Date and time when the session record was modified in Sitecore CDP. | ISO 8601 Date/Time UTC | "2026-09-08T16:17.000Z" |
meta_browser_ref | The unique browser ID generated by Sitecore CDP. This is used for guest identification. | string | "405bbc9f-bb43-451d-98e5-4fa899ce6a75" |
session_data | A collection of name-value pair attributes that store your organization's custom session data. | map <string, string> | {a=alpha, b=beta} |
type | The type of session. | string | "WEB", "MOBILE_WEB" |
raw_json | The overall session 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 sessions.
| Name | Description | Type | Example |
|---|---|---|---|
cartType | The cart interaction for the session. Possible values are:
| string | "CONVERTED" |
firstPageURI | The uniform resource identifier (URI) of the page on which this session started. | string | "homepage" |
language | The language for this session. | string | "EN" |
lastPageURI | The uniform resource identifier (URI) of the page on which this session ended. | string | "searchpage" |
numAdds | The number of items added to the cart during this session. | integer | 2 |
numCheckouts | The number of times the visitor started the checkout process. | integer | 1 |
numConfirms | The number of times the visitor confirmed payment during this session. The value is usually 0 or 1. | integer | 1 |
numPayments | The number of times payment details were submitted during this session. The value is usually 0 or 1. | integer | 0 |
numSearches | The number of searches performed during this session. | integer | 4 |
numSelects | The number of times a product was selected (clicked) during this session. | integer | 6 |
numViews | The number of page view events recorded for this session. | integer | 5 |
operatingSystem | The operating system used in this session. | string | "Windows 10" |
userAgent | The user agent used in this session. | string | "Chrome 10" |
utmCampaign | The UTM campaign included in this session. | string | "contentpromotion" |
utmContent | The UTM content included in this session. | string | "call_to_action" |
utmMedium | The UTM medium included in this session. | string | "social" |
utmSource | The UTM source included in this session. | string | "bing" |
utmTerm | The UTM term included in this session. | string | "New York" |
If you have suggestions for improving this article, let us know!