Fields reference (session)
Geography
Section titled GeographyCity associated to the user.
Data type | Example value |
---|---|
String | Paris |
country_code
Section titled country_codeCountry associated to the user.
Data type | Example value |
---|---|
String | FR |
language
Section titled languageLanguage associated to the user.
Data type | Example value |
---|---|
String | fr |
Identifiers
Section titled Identifiersproject_id
Section titled project_idUnique project identifier.
Data type | Example value |
---|---|
Integer | 42 |
user_id
Section titled user_idUnique user identifier.
This is the hash of the user_id_unashed
identifier.
Data type | Example value |
---|---|
Integer | 5066017809039612144 |
user_id_unhashed
Section titled user_id_unhashedUnique user identifier.
User id stored in a cookie named _cs_id
, which has a lifetime of 13 months.
Data type | Example value |
---|---|
String | ae267-6g87D-88Nn6od |
Mobile (CS App)
Section titled Mobile (CS App)Those fields are only available for Apps projects.
app_events.event_name
Section titled app_events.event_nameList of the app event names.
Each app event has the same index in all app_events.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘appStartEvent’, ‘appShowEvent’, ‘appHideEvent’] |
app_events.event_time
Section titled app_events.event_timeList of dates and UTC times of the app events.
Each app event has the same index in all app_events.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘2020-06-24 17:07:42’, ‘2020-06-24 17:07:42’, ‘2020-06-24 17:08:53’] |
app_events.event_type
Section titled app_events.event_typeList of the app events types related to the session:
0
: app start1
: app show2
: app hide
Each app event has the same index in all app_events.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [0, 1, 2] |
app_events.view_number
Section titled app_events.view_numberThe pageview number related to the event.
Each app event has the same index in all app_events.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [0, 0, 1] |
app_version
Section titled app_versionThe client app version.
Data type | Example value |
---|---|
String | 10.8.2.0 |
density
Section titled densityPixel density measured in Pixels Per Inch (PPI) on the display.
Data type | Example value |
---|---|
Float | 38912.312 |
manufacturer
Section titled manufacturerThe mobile device manufacturer.
Data type | Example value |
---|---|
String | HUAWEI |
model
Section titled modelThe mobile device model.
Data type | Example value |
---|---|
String | SNE-LX1 |
os_version
Section titled os_versionVersion of Android or iOS used by the visitor (iOS 13.1. or iOS 13.2 etc.)
Data type | Example value |
---|---|
Integer | 2251799813685248 |
Session
Section titled Sessiondynamic_vars_int_in_session.key
Section titled dynamic_vars_int_in_session.keyArray of keys of integer dynamic variables extracted from the website datalayer.
Each variable has the same index in all dynamic_vars_int_in_session.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘VAR_name_123’, VAR_name_456’] |
dynamic_vars_int_in_session.value
Section titled dynamic_vars_int_in_session.valueArray of values of integer dynamic variables extracted from the website datalayer.
Each variable has the same index in all dynamic_vars_int_in_session.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [123, 456] |
dynamic_vars_string_in_session.key
Section titled dynamic_vars_string_in_session.keyArray of keys of string dynamic variables extracted from the website datalayer.
Each variable has the same index in all dynamic_vars_string_in_session.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘VAR_name_123’, VAR_name_456’] |
dynamic_vars_string_in_session.value
Section titled dynamic_vars_string_in_session.valueArray of values of string dynamic variables extracted from the website datalayer.
Each variable has the same index in all dynamic_vars_string_in_session.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘VAR_value_123’, ‘VAR_value_456’] |
is_excludable
Section titled is_excludableValues are either 1 or 0, to indicate whether the session is generated from bot traffic (1) or not (0).
Data type | Example value |
---|---|
Integer | 1 |
is_recorded
Section titled is_recordedFor Session Replay, indicates whether the session was collected (1) or not (0). This field can only be exported for projects with access to Session Replay.
Data type | Example value |
---|---|
Integer | 1 |
session_add_to_cart_items.add_to_cart_time
Section titled session_add_to_cart_items.add_to_cart_timeThose values are populated when sending an add to cart event to Contentsquare.
Array of the datetimes when the items were added to cart.
Each item has the same index in all session_add_to_cart_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘2020-06-24 17:07:42’, ‘2020-06-24 17:07:42’, ‘2020-06-24 17:08:53’] |
session_add_to_cart_items.add_to_cart_view_number
Section titled session_add_to_cart_items.add_to_cart_view_numberThose values are populated when sending an add to cart event to Contentsquare.
Array of the page view numbers (position in session) from which items were added to cart.
Each item has the same index in all session_add_to_cart_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [2, 5, 3] |
session_add_to_cart_items.catalog_id
Section titled session_add_to_cart_items.catalog_idThose values are populated when sending an add to cart event to Contentsquare.
Array of the catalog identifiers of the items added to the cart. Will be 0 if the project has no Merchandising catalog set-up.
Each item has the same index in all session_add_to_cart_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [71893, 0, 991893] |
session_add_to_cart_items.is_in_transaction
Section titled session_add_to_cart_items.is_in_transactionThose values are populated when sending an add to cart event to Contentsquare.
Array of the booleans indicating whether the items added to cart were purchased (1) or not (0).
Each item has the same index in all session_add_to_cart_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [0, 0, 1] |
session_add_to_cart_items.product_id_hashed
Section titled session_add_to_cart_items.product_id_hashedThose values are populated when sending an add to cart event to Contentsquare.
Array of the items’ hashed identifiers. Will be ‘0’ if the project has no Merchandising catalog set-up.
Each item has the same index in all session_add_to_cart_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘3976139’, ‘0’, ‘30230O013’] |
session_add_to_cart_items.sku
Section titled session_add_to_cart_items.skuThose values are populated when sending an add to cart event to Contentsquare.
Array of the SKUs of the items added to cart.
Each item has the same index in all session_add_to_cart_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘987897849120’, ‘47807017348784’] |
session_date
Section titled session_dateSession start date.
Data type | Example value |
---|---|
String | 2020-07-26 |
session_duration_msec
Section titled session_duration_msecSession duration in milliseconds.
Data type | Example value |
---|---|
Integer | 881633 |
session_id
Section titled session_idUnique session identifier.
Data type | Example value |
---|---|
Integer | 5066017809039605767 |
session_number
Section titled session_numberThe number of sessions of the user (takes into account how many times the user visited before).
Data type | Example value |
---|---|
Integer | 7 |
session_number_of_transactions
Section titled session_number_of_transactionsNumber of transactions placed during the session.
Data type | Example value |
---|---|
Integer | 2 |
session_number_of_views
Section titled session_number_of_viewsThe number of page views in the session.
Data type | Example value |
---|---|
Integer | 5 |
session_replay_link
Section titled session_replay_linkThe replay link, if the session was collected (see is_recorded
field).
This field can only be exported for projects with access to Session Replay.
Data type | Example value |
---|---|
String | https://app.contentsquare.com/quick-playback/index.html?pid=… |
session_time
Section titled session_timeSession start date and UTC time.
Data type | Example value |
---|---|
String | 2020-07-26 05:53:04 |
session_transaction_items.catalog_id
Section titled session_transaction_items.catalog_idThose values are populated when sending a transaction event to Contentsquare.
Array of the catalog identifiers of the purchased items. Will be 0 if the project has no Merchandising catalog set-up.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [71893, 0, 991893] |
session_transaction_items.id
Section titled session_transaction_items.idThose values are populated when sending a transaction event to Contentsquare.
Array of the transactions identifiers.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘ABC287632’, ‘ABC1290873’] |
session_transaction_items.product_id_hashed
Section titled session_transaction_items.product_id_hashedThose values are populated when sending a transaction event to Contentsquare.
Array of the items’ hashed identifiers. Will be ‘0’ if the project has no Merchandising catalog set-up.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘3976139’, ‘0’, ‘30230O013’] |
session_transaction_items.quantity
Section titled session_transaction_items.quantityThose values are populated when sending a transaction event to Contentsquare.
Array of the purchased quantity of the items.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [2, 4, 1] |
session_transaction_items.revenue_cents
Section titled session_transaction_items.revenue_centsThose values are populated when sending a transaction event to Contentsquare.
Array of the revenues (in cents) of the purchased items.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [89211, 450] |
session_transaction_items.sku
Section titled session_transaction_items.skuThose values are populated when sending an add to cart event to Contentsquare.
Array of the SKUs of the purchased items.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘987897849120’, ‘47807017348784’] |
session_transaction_items.transaction_time
Section titled session_transaction_items.transaction_timeThose values are populated when sending a transaction event to Contentsquare.
Array of the datetimes when the items were purchased.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(String) | [‘2020-06-24 17:07:42’, ‘2020-06-24 17:07:42’, ‘2020-06-24 17:08:53’] |
session_transaction_items.transaction_view_number
Section titled session_transaction_items.transaction_view_numberThose values are populated when sending a transaction event to Contentsquare.
Array of the page view numbers (position in session) from which items were purchased.
Each item has the same index in all session_transaction_items.*
fields.
Data type | Example value |
---|---|
Array(Integer) | [2, 5, 3] |
session_transactions_revenue_cents
Section titled session_transactions_revenue_centsTotal revenue generated by the session (in US dollar cents).
Data type | Example value |
---|---|
Integer | 37655 |
referer_url
Section titled referer_urlThe referring URL to the first page view of the session.
Data type | Example value |
---|---|
String | https://www.google.fr/ |
Technology
Section titled Technologybrowser_major_version
Section titled browser_major_versionThe browser major version.
Data type | Example value |
---|---|
Integer | 83 |
browser_name
Section titled browser_nameThe browser name.
Data type | Example value |
---|---|
String | Chrome |
browser_version
Section titled browser_versionThe browser version.
Data type | Example value |
---|---|
String | 83.0.4103.116 |
device_id
Section titled device_idUnique device identifier:
0
: Unknown1
: Desktop2
: Mobile (Web)3
: Tablet (Web)4
: Mobile (App)5
: Tablet (App)
Data type | Example value |
---|---|
Integer | 2 |
platform_name
Section titled platform_nameThe operating system name.
Data type | Example value |
---|---|
String | Windows |
platform_version
Section titled platform_versionThe operating system version.
Data type | Example value |
---|---|
Integer | 10 |
screen_height
Section titled screen_heightThe screen height in pixels.
Data type | Example value |
---|---|
Integer | 700 |
screen_width
Section titled screen_widthThe screen width in pixels.
Data type | Example value |
---|---|
Integer | 1280 |