---
title: UA schema reference
slug: pase9158
canonical_url: https://docs.coveo.com/en/pase9158/
collection: coveo-analytics
source_format: adoc
---
# UA schema reference
This article provides a column-level reference for each view in the **UA** schema of the [UA Events data model](https://docs.coveo.com/en/parh0160/) in Snowflake

## `all_events_shared`

The `all_events_shared` view contains all events (search, click, view, and custom) in a single table.

[%header,cols="2"]
|===
|Column name
|Description

|`account_id`
|Unique identifier for the organization

|`advanced_query_expression`
|Advanced query expression used for the search event

|`batch_id`
|Unique identifier for the batch of events (if the event came through the searches endpoint)

|`cause2`
|Action cause of the event

|`click_id`
|Unique identifier of the click event

|`click_rank`
|Position of the clicked item (1-based integer value)

|`client_id`
|Unique identifier for this browser, can be null if not sent explicitly

|`collection_name`
|Name of the collection of the clicked item

|`custom_datas`
|User-supplied custom values attached to this specific event

|`custom_event_id`
|Unique identifier for a custom event (null for search or click events in this view)

|`datetime`
a|UTC timestamp of when this event was received
> **Note**
>
> This field is stored as `TIMESTAMP_NTZ` in Snowflake.
> When working with different time zones, convert the value to a timezone-aware type (`TIMESTAMP_TZ`) to ensure accurate results.

|`device_category`
|Device category, extracted from `userAgent` string

|`device_id` (unused)
|Unique device identifier, when available

|`document_author`
|Author of the clicked item

|`document_category`
|Category of the clicked item

|`document_title`
|Title of the clicked item

|`event_outcome` (unused)
|Integer outcome of event

|`event_type`
|Event type of the event, used to distinguish the type of event

|`event_value`
|Event value of the custom event

|`facet_state`
|Facet state of the search event (includes only selected facets)

|`index_id`
|Index name against which the search query ran

|`is_anonymous`
|Whether the user should be considered anonymous

|`is_contextual`
|Whether the query is modified by contextual filters (for example, a query to find similar items)

|`is_internal`
|Whether the IP address of the event was considered a customer-internal IP

|`number_of_results`
|Number of returned search results

|`operating_system`
|Operating system of the device, extracted from `user_agent`

|`operating_system_with_version`
|Operating system of the device along with its version, extracted from `user_agent`

|`origin_city`
|City from which the event originated, extracted from IP

|`origin_context`
|Specifies the deployment from which the user performs the search action

|`origin_country`
|Country from which the event originated, extracted from IP

|`origin_language`
|Language of the displayed content (must be a valid ISO 639-1 code)

|`origin_level_1`
|Name or identifier of the search interface for this event (that is, `searchHub`)

|`origin_level_2`
|Name or identifier of the search tab for this event (that is, `searchTab`)

|`origin_level_3`
|Previous location visited (for example `documentreferrer`)

|`origin_region`
|Region from which the event originated, extracted from IP

|`query_expression`
|Query expression of the search event

|`query_expression_lower`
|Lowercase version of the query expression from the search event

|`query_pipeline`
|Name of the query pipeline associated with this event

|`ranking_modifier`
|ML model responsible for the results in this click event

|`response_time_ms`
|Number of milliseconds it took to return the search results

|`search_id`
|Unique `searchId` of the search event

|`source_name`
|Source name of the clicked item

|`split_test_run_name`
|Pipeline AB-test split information for this event

|`split_test_run_version`
|Pipeline AB-test split version for this event

|`system_uri_hash`
|URI hash of the clicked item

|`tracking_id`
|Passed website or tracking ID

|`unique_user_id`
|Unique identifier for this user, based on the `user_id` or `client_id` (if anonymous)

|`user_agent`
|`user_agent` string as reported by the browser

|`user_id`
|Unique identifier for this user

|`user_ip`
|Cryptographic hash of the user IP

|`user_name`
|User name

|`visit_id`
|Identifier for the unique visit for this user

|`visitor_id`
|Unique identifier for this visitor (superseded by `client_id`)

|`web_browser`
|Web browser used on the device, extracted from `user_agent`

|`web_browser_with_version`
|Web browser used on the device and its version, extracted from `user_agent`

|`with_clicks`
|Search event that had results that were clicked on

|`with_results`
|Search event that had non-zero results
|===

## `clicks_shared`

The `clicks_shared` view contains all client-side click [events](https://docs.coveo.com/en/260/).

[%header,cols="2"]
|===
|Column name |Description

|`account_id`
|Organization identifier for this record

|`cause`
|Action cause for this event

|`cause2`
|Action cause for this event

|`click_id`
|Unique identifier for this click event

|`click_rank`
|Position of the clicked item (1-based integer value)

|`client_id`
|Unique identifier for this browser, can be null if not sent explicitly

|`collection_name`
|`@syscollection` field value of the clicked item

|`custom_datas`
|User-supplied custom values attached to this specific event

|`datetime`
|UTC timestamp of when this event was received

|`device_category`
|Device category, extracted from the `user_agent` string

|`device_id` (unused)
|Unique device identifier, when available

|`document_author`
|Author of clicked item

|`document_category`
|Category of the clicked item

|`document_title`
|Title of clicked item

|`document_url`
|URL of clicked item

|`is_anonymous`
|Whether the user should be considered anonymous

|`is_internal`
|Whether the IP address of the event was considered a customer-internal IP

|`operating_system`
|Operating system of the device, extracted from `user_agent`

|`operating_system_with_version`
|Operating system of the device along with its version, extracted from `user_agent`

|`origin_city`
|City from where the event originated, extracted from IP

|`origin_context`
|Specifies the deployment from which the user performs the search action

|`origin_country`
|Country from which the event originated, extracted from IP

|`origin_language`
|Language of the displayed content (must be a valid ISO 639-1 code)

|`origin_level_1`
|Name or identifier of the search interface for this event (that is, `searchHub`)

|`origin_level_2`
|Name or identifier of the search tab for this event (that is, `searchTab`)

|`origin_level_3`
|Previous location visited (for example, `documentreferrer`)

|`origin_region`
|Region from which the event originated, extracted from IP

|`query_pipeline`
|Query pipeline name associated with this event

|`ranking_modifier`
|ML algorithm responsible for the results in this click event

|`search_id`
|Unique search ID of the search event which returned the clicked item

|`source_name`
|Source name of the clicked item

|`split_test_run_name`
|Pipeline AB-test split information for this event

|`split_test_run_version`
|Pipeline AB-test split version for this event

|`system_uri_hash`
|URI hash of the clicked item

|`tracking_id`
|Passed website or tracking ID

|`unique_user_id`
|Unique identifier for this user, based on the `user_id` or `client_id` (if anonymous)

|`user_agent`
|`user_agent` string as reported by the browser

|`user_id`
|Unique identifier for this user

|`user_ip`
|Cryptographic hash of the user IP

|`user_name`
|User name

|`visit_id`
|Identifier for the unique visit for this user

|`visitor_id`
|Unique identifier for this visitor (superseded by `client_id`)

|`web_browser`
|Web browser used on the device, extracted from `user_agent`

|`web_browser_with_version`
|Web browser used on the device and its version, extracted from `user_agent`
|===

## `custom_events_shared`

The `custom_events_shared` view contains all client-side custom [events](https://docs.coveo.com/en/260/)
Custom events are defined to track specific user interactions that aren't covered by standard search, click, or view events.

[%header,cols="2"]
|===
|Column name
|Description

|`account_id`
|Unique identifier for the organization

|`client_id`
|Unique identifier for this browser, can be null if not sent explicitly

|`custom_datas`
|User-supplied custom values attached to this specific event

|`custom_event_id`
|Unique identifier for this custom event

|`datetime`
|UTC timestamp of when this event was received

|`device_category`
|Device category, extracted from `user_agent`

|`device_id` (unused)
|Unique device identifier, when available

|`event_outcome` (unused)
|Integer outcome of event

|`event_type`
|Event type of the custom event, used to distinguish the type of event

|`event_value`
|Event value of the custom event

|`is_anonymous`
|Whether the user should be considered anonymous

|`is_internal`
|Whether the IP address of the event was considered a customer-internal IP

|`last_search_id`
|Unique search ID of the last search event performed by the user

|`operating_system`
|Operating system of the device, extracted from `user_agent`

|`operating_system_with_version`
|Operating system of the device along with its version, extracted from `user_agent`

|`origin_city`
|City from where the event originated, extracted from IP

|`origin_context`
|Specifies the deployment from which the user performs the search action

|`origin_country`
|Country from which the event originated, extracted from IP

|`origin_language`
|Language of the displayed content (must be a valid ISO 639-1 code)

|`origin_level_1`
|Name or identifier of the search interface for this event (that is, `searchHub`)

|`origin_level_2`
|Name or identifier of the search tab for this event (that is, `searchTab`)

|`origin_level_3`
|Previous location visited (for example, `documentreferrer`)

|`origin_region`
|Region from which the event originated, extracted from IP

|`split_test_run_name`
|Pipeline AB-test split information for this event

|`split_test_run_version`
|Pipeline AB-test split version for this event

|`tracking_id`
|Passed website or tracking ID

|`unique_user_id`
|Unique identifier for this user, based on the `user_id` or `client_id` (if anonymous)

|`user_agent`
|`user_agent` string as reported by the browser

|`user_id`
|Unique identifier for this user

|`user_ip`
|Cryptographic hash of the user IP

|`user_name`
|User name

|`visit_id`
|Identifier for the unique visit for this user

|`visitor_id`
|Unique identifier for this visitor (superseded by `client_id`)

|`web_browser`
|Web browser used on the device, extracted from `user_agent`

|`web_browser_with_version`
|Web browser used on the device and its version, extracted from `user_agent`
|===

## `groups_shared`

The `groups_shared` view contains the mapping of search events to their associated user groups.

[%header,cols="2"]
|===
|Column name
|Description

|`account_id`
|Unique identifier for the organization

|`datetime`
|UTC timestamp of when the search event was received

|`group_name`
|Name of the user group

|`search_id`
|Unique search ID of the search event
|===

## `keywords_shared`

The `keywords_shared` view contains all keywords associated with search [events](https://docs.coveo.com/en/260/).

[%header,cols="2"]
|===
|Column name
|Description

|`account_id`
|Unique identifier for the organization

|`datetime`
|UTC timestamp of when the search event was received

|`keyword`
|Keyword associated with the search event

|`search_id`
|Unique search ID of the search event
|===

## `searches_shared`

The `searches_shared` view contains all client-side search [events](https://docs.coveo.com/en/260/) and captured server-side search events

[%header,cols="2"]
|===
|Column name
|Description

|`account_id`
|Unique identifier for the organization

|`advanced_query_expression`
|Advanced query expression used for the search event

|`batch_id`
|Unique identifier for the batch of events (if the event came through the searches endpoint)

|`cause`
|Action cause of the event

|`cause2`
|Action cause of the event

|`client_id`
|Unique identifier for this browser, can be null if not sent explicitly

|`custom_datas`
|User-supplied custom values attached to this specific event

|`datetime`
|UTC timestamp of when this event was received

|`device_category`
|Device category, extracted from `user_agent`

|`device_id` (unused)
|Unique device identifier, when available

|`facet_state`
|Facet state of the search event (includes only selected facets)

|`index_id`
|Index name the search query ran against

|`is_anonymous`
|Whether the user should be considered anonymous

|`is_contextual`
|Whether the query is modified by contextual filters (for example, a query to find similar items)

|`is_internal`
|Whether the IP address of the event was considered a customer-internal IP

|`number_of_results`
|Number of returned search results

|`operating_system`
|Operating system of the device, extracted from `user_agent`

|`operating_system_with_version`
|Operating system of the device along with its version, extracted from `user_agent`

|`origin_city`
|City from which the event originated, extracted from IP

|`origin_context`
|Specifies the deployment from which the user performs the search action

|`origin_country`
|Country from which the event originated, extracted from IP

|`origin_language`
|Language of the displayed content (must be a valid ISO 639-1 code)

|`origin_level_1`
|Name or identifier of the search interface for this event (that is, `searchHub`)

|`origin_level_2`
|Name or identifier of the search tab for this event (that is, `searchTab`)

|`origin_level_3`
|Previous location visited (for example `documentreferrer`)

|`origin_region`
|Region from which the event originated, extracted from IP

|`query_expression`
|Query expression of the search event

|`query_expression_lower`
|Lowercase version of the query expression from the search event

|`query_pipeline`
|Query pipeline associated with this event

|`response_time_ms`
|Number of milliseconds it took to return the search results

|`search_id`
|Unique search ID of the search event

|`split_test_run_name`
|Pipeline AB-test split information for this event

|`split_test_run_version`
|Pipeline AB-test split version for this event

|`tracking_id`
|Passed website or tracking ID

|`unique_user_id`
|Unique identifier for this user, based on the `user_id` or `client_id` (if anonymous)

|`user_agent`
|`user_agent` string as reported by the browser

|`user_id`
|Unique identifier for this user

|`user_ip`
|Cryptographic hash of the user IP

|`user_name`
|User name

|`visit_id`
|Identifier for the unique visit for this user

|`visitor_id`
|Unique identifier for this visitor (superseded by `client_id`)

|`web_browser`
|Web browser used on the device, extracted from `user_agent`

|`web_browser_with_version`
|Web browser used on the device and its version, extracted from `user_agent`

|`with_clicks`
|Whether the search event presented results that were clicked on

|`with_results`
|Whether the search event had non-zero results
|===

## `views_shared`

The `views_shared` view contains all client-side view [events](https://docs.coveo.com/en/260/).

[%header,cols="2"]
|===
|Column name
|Description

|`account_id`
|Unique identifier for the organization

|`client_id`
|Unique identifier for this browser, can be null if not sent explicitly

|`content_id_key`
|Key name of the viewed item

|`content_id_value`
|Unique identifier of the viewed item and value associated with the `content_id_key`

|`content_type`
|Type of content being viewed (for example, article, video, etc)

|`custom_datas`
|User-supplied custom values attached to this specific event

|`datetime`
|UTC timestamp of when this event was received

|`device_category`
|Device category, extracted from `user_agent`

|`device_id` (unused)
|Unique device identifier, when available

|`is_anonymous`
|Whether the user should be considered anonymous

|`is_internal`
|Whether the IP address of the event was considered a customer-internal IP

|`location_uri`
|URI of the viewed item

|`operating_system`
|Operating system of the device, extracted from `user_agent`

|`operating_system_with_version`
|Operating system of the device along with its version, extracted from `user_agent`

|`origin_city`
|City from which the event originated, extracted from IP

|`origin_context`
|Specifies the deployment from which the user performs the search action

|`origin_country`
|Country from which the event originated, extracted from IP

|`origin_language`
|Language of the displayed content (must be a valid ISO 639-1 code)

|`origin_level_1`
|Name or identifier of the search interface for this event (that is, `searchHub`)

|`origin_level_2`
|Name or identifier of the search tab for this event (that is, `searchTab`)

|`origin_level_3`
|Previous location visited (for example, `documentreferrer`)

|`origin_region`
|Region from which the event originated, extracted from IP

|`referrer_uri`
|Referrer URI of the viewed item

|`split_test_run_name`
|Pipeline AB-test split information for this event

|`split_test_run_version`
|Pipeline AB-test split version for this event

|`title`
|Title of the viewed item or page

|`tracking_id`
|Passed website or tracking ID

|`unique_user_id`
|Unique identifier for this user, based on the `user_id` or `client_id` (if anonymous)

|`user_agent`
|`user_agent` string as reported by the browser

|`user_id`
|Unique identifier for this user

|`user_ip`
|Cryptographic hash of the user IP

|`user_name`
|User name

|`view_event_id`
|Unique identifier for this view event

|`visit_id`
|Identifier for the unique visit for this user

|`visitor_id`
|Unique identifier for this visitor (superseded by `client_id`)

|`web_browser`
|Web browser used on the device, extracted from `user_agent`

|`web_browser_with_version`
|Web browser used on the device and its version, extracted from `user_agent`
|===