Screen Viewed
The Screen Viewed event is triggered when a views a screen within an experience. This occurs when the user launches an experience and views the initial “home” screen of the experience as well as when the user taps a button that navigates to another screen in the experience.
Table Schema
Screen Viewed events are stored in BigQuery in the experience_screen_viewed
table. The following is a detailed description of each column in the table grouped by data model.
Event
Properties of the Screen Viewed event.
Column | Description |
---|---|
event.timestamp | A UNIX timestamp (seconds since January 1st, 1970 at UTC) indicating the time the event occurred. |
event.experience_session_id | Deprecated Use the event.attributes.experience_session_id column instead. |
event.from_screen_id | Deprecated Use the event.attributes.from_screen_id column instead. |
event.from_block_id | Deprecated Use the event.attributes.from_block_id column instead. |
event.attributes.experience_id | The ID of the experience the viewed screen belongs to. |
event.attributes.screen_id | The ID of the viewed screen. |
event.attributes.version_id | Each time an experience is published a new version is created. This column stores the ID of the specific version of the experience the viewed screen belongs to. |
event.attributes.experience_session_id | The time between when a user launches an experience and dismisses it is called a session. This column is a unique ID assigned to the session in-which the screen was viewed. The session ID is useful for certain reports such as calculating the average time spent engaging with an experience. |
event.attributes.from_screen_id | If the screen was navigated to by the user tapping a block, the value stored in this column will be the ID of the screen the tapped block belongs to. |
event.attributes.from_block_id | If the screen was navigated to by the user tapping a block, the value stored in this column will be the ID of the tapped block. |
event.attributes.timestamp | Deprecated Use the event.timestamp column instead. |
Experience
The experience the viewed screen belongs to.
Column | Description |
---|---|
experience.id | The experience’s ID. |
experience.version_id | Each time an experience is published a new version is created. This column stores the ID of the specific version of the experience the event is associated with. |
experience.screen_id | Deprecated Use screen.id instead |
experience.block_id | Deprecated Use block.id instead |
experience.block_action.type | Deprecated Use block.action.type instead |
experience.block_action.screen_id | Deprecated Use block.action.screen_id instead |
experience.name | The experience’s name. |
experience.screen_ids | The IDs of the screens belonging to the experience. |
Screen
The screen that was viewed.
Column | Description |
---|---|
screen.id | The screen’s ID. |
screen.name | The screen’s name. |
screen.row_ids | The IDs of the rows belonging to the screen. |
From Screen
If the screen was navigated to by the user tapping a block, the “From Screen” is the screen the tapped block belongs to.
Column | Description |
---|---|
screen.id | The screen’s ID. |
screen.name | The screen’s name. |
screen.row_ids | The IDs of the rows belonging to the screen. |
From Row
If the screen was navigated to by the user tapping a block, the “From Row” is the row the tapped block belongs to.
Column | Description |
---|---|
row.id | The row’s ID. |
row.name | The row’s name. |
row.block_ids | The IDs of the blocks belonging to the row. |
row.position | The numeric position the row appears in its screen, from top-to-bottom, starting at 1. |
From Block
If the screen was navigated to by the user tapping a block, the “From Block” is the block that was tapped.
Column | Description |
---|---|
block.id | The block’s ID. |
block.name | The block’s name. |
block.type | The type of block – one of: “barcode-block”, “button-block”, “image-block”, “rectangle-block”, “text-block” or “webview-block”. |
block.position | The numeric position the block appears in its row, from top-to-bottom, starting at 1. |
block.action.type | The type of action that should be taken when the block is tapped. The value in this column will be either “go-to-screen”, “open-url” or null if there is no action assigned to the block. |
block.action.url | If the block action type is “open-url”, the value in this column will be the URL that should be opened when tapped. |
block.action.screen_id | If the block action type is “go-to-screen”, the value in this column will be the ID of the screen that should be navigated to. |
Device
The device that triggered the event.
Column | Description |
---|---|
device.id | A unique device identifier. On iOS this is the value returned from UIDevice.identifierForVendor. On Android this is a UUID generated by the Rover SDK. |
device.token | The token used by APNS or FCM/GCM to sent notifications to the device. |
device.locale_lang | The language portion of device’s current locale as set in the device’s system settings. E.g. “en”. |
device.locale_region | The region dialect portion of device’s current locale as set in the device’s system settings. E.g. “US”. |
device.time_zone | The device’s current time zone. E.g. “America/Toronto” |
device.sdk_version | The version of the Rover SDK the device has installed. E.g. 1.6.2 |
device.platform | A value of “iOS” or “Android” indicates this event was created by a device through the Rover SDK in a native app. A value of “Web” means the event was triggered by a device through a web browser. Currently the only events that can be triggered through a web browser are experience events when viewing a mobile-web version of an experience. |
device.os_name | The name of the operating system the device is running. E.g. “iOS” |
device.os_version | The version of the operating system the device is running. E.g. 11.1.2 |
device.model | The name of the device model. E.g. “iPhone 6 Plus” |
device.manufacturer | The manufacturer of the device. E.g. “Samsung” |
device.carrier | The mobile carrier the device is currently connected to. E.g. “T-Mobile” |
device.app_identifier | The unique identifier of the app the device is running. E.g. “com.example.MyApp” |
device.background_enabled | Deprecated No longer in use. |
device.notifications_enabled | Deprecated Use device.notification_authorization instead. |
device.bluetooth_enabled | Indicates whether the device currently has Bluetooth enabled. |
device.location_monitoring_enabled | Indicates whether location monitoring is enabled. This could be turned off permanently in the system settings or by switching on airplane mode. |
device.aid | The advertising identifier associated with the device. On iOS this is the value returned from advertisingIdentifier. |
device.location.latitude | The latitude of the device’s last known location obtained from a location update. |
device.location.longitude | The longitude of the device’s last known location obtained from a location update. |
device.location.accuracy | The accuracy of the device’s last known location obtained from a location update, measured in metres. |
device.ip | The last known IP address of the device. |
device.notification_authorization | Indicates whether the device has authorized the app to display notifications. |
Customer
Deprecated The customer model and all of its columns are deprecated and no longer in use.