---
title: Fields reference (session) - APIs
description: Data Export session fields reference
lastUpdated: 27 April 2025
source_url:
  html: https://docs.contentsquare.com/en/api/export/fields-reference-session/
  md: https://docs.contentsquare.com/en/api/export/fields-reference-session/index.md
---

## Geography

### `city`

City associated to the user.

| Data type | Example value |
| - | - |
| String | Paris |

### `country_code`

Country associated to the user.

| Data type | Example value |
| - | - |
| String | FR |

### `language`

Language associated to the user.

| Data type | Example value |
| - | - |
| String | fr |

## Identifiers

### `project_id`

Unique project identifier.

| Data type | Example value |
| - | - |
| Integer | 42 |

### `user_id`

Unique user identifier. This is the hash of the `user_id_unashed` identifier.

| Data type | Example value |
| - | - |
| Integer | 5066017809039612144 |

### `user_id_unhashed`

Unique user identifier. User id stored in a cookie named `_cs_id`, which has a lifetime of 13 months.

Note

This field will be empty for dates prior to September, 5th 2023, as this identifier was not collected before that date.

| Data type | Example value |
| - | - |
| String | ae267-6g87D-88Nn6od |

## Mobile (CS App)

Those fields are only available for Apps projects.

### `app_events.event_name`

List 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`

List 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', '2020-06-24 17:07', '2020-06-24 17:08'] |

### `app_events.event_type`

List of the app events types related to the session:

* `0`: app start
* `1`: app show
* `2`: 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`

The 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`

The client app version.

| Data type | Example value |
| - | - |
| String | 10.8.2.0 |

### `density`

Pixel density measured in Pixels Per Inch (PPI) on the display.

| Data type | Example value |
| - | - |
| Float | 38912.312 |

### `manufacturer`

The mobile device manufacturer.

| Data type | Example value |
| - | - |
| String | HUAWEI |

### `model`

The mobile device model.

| Data type | Example value |
| - | - |
| String | SNE-LX1 |

### `os_version`

Version of Android or iOS used by the visitor (iOS 13.1. or iOS 13.2 etc.)

| Data type | Example value |
| - | - |
| Integer | 2251799813685248 |

## Session

### `dynamic_vars_int_in_session.key`

Array 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`

Array 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`

Array 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`

Array 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`

Values 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`

For 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`

*Those 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', '2020-06-24 17:07', '2020-06-24 17:08'] |

### `session_add_to_cart_items.add_to_cart_view_number`

*Those 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`

*Those 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`

*Those 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`

*Those 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`

*Those 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`

Session start date.

| Data type | Example value |
| - | - |
| String | 2020-07-26 |

### `session_duration_msec`

Session duration in milliseconds.

| Data type | Example value |
| - | - |
| Integer | 881633 |

### `session_id`

Unique session identifier.

| Data type | Example value |
| - | - |
| Integer | 5066017809039605767 |

### `session_number`

The 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`

Number of transactions placed during the session.

| Data type | Example value |
| - | - |
| Integer | 2 |

### `session_number_of_views`

The number of page views in the session.

| Data type | Example value |
| - | - |
| Integer | 5 |

### `session_replay_link`

The 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`

Session start date and UTC time.

| Data type | Example value |
| - | - |
| String | 2020-07-26 05:53 |

### `session_transaction_items.catalog_id`

*Those 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`

*Those 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`

*Those 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`

*Those 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`

*Those 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`

*Those 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`

*Those 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', '2020-06-24 17:07', '2020-06-24 17:08'] |

### `session_transaction_items.transaction_view_number`

*Those 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`

Total revenue generated by the session (in US dollar cents).

| Data type | Example value |
| - | - |
| Integer | 37655 |

### `referer_url`

The referring URL to the first page view of the session.

| Data type | Example value |
| - | - |
| String | https\://www\.google.fr/ |

## Technology

### `browser_major_version`

The browser major version.

| Data type | Example value |
| - | - |
| Integer | 83 |

### `browser_name`

The browser name.

| Data type | Example value |
| - | - |
| String | Chrome |

### `browser_version`

The browser version.

| Data type | Example value |
| - | - |
| String | 83.0.4103.116 |

### `device_id`

Unique device identifier:

* `0`: Unknown
* `1`: Desktop
* `2`: Mobile (Web)
* `3`: Tablet (Web)
* `4`: Mobile (App)
* `5`: Tablet (App)

| Data type | Example value |
| - | - |
| Integer | 2 |

### `platform_name`

The operating system name.

| Data type | Example value |
| - | - |
| String | Windows |

### `platform_version`

The operating system version.

| Data type | Example value |
| - | - |
| Integer | 10 |

### `screen_height`

The screen height in pixels.

| Data type | Example value |
| - | - |
| Integer | 700 |

### `screen_width`

The screen width in pixels.

| Data type | Example value |
| - | - |
| Integer | 1280 |