is now Sisense for Cloud Data Teams
Usage Data Dictionary
Usage Data is a data repository containing all metadata for a Sisense for Cloud Data Teams site. Below is a list of all tables and columns included in the repository, including the column types and descriptions. General information on the feature can be found on our main Usage Data page.
Charts
The charts table lists all charts that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those charts.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique chart ID |
| name | String | Chart name |
| sql | String | Complete chart SQL query text |
| created_at | Timestamp | Chart created timestamp |
| created_by | Integer | Chart creator user ID |
| updated_at | Timestamp | Last chart modification timestamp made by either a user or the system. This column can be used to show how recently the chart has been modified. |
| deleted_at | Timestamp | Chart deleted timestamp |
| dashboard_id | Integer | Dashboard ID for the dashboard the chart is located on |
| space_id | Integer | Space ID for the space that the chart is located on |
| database_name | String | Name of the database selected in the chart editor dropdown list |
| csv_url_token | String | The unique token for the public CSV URL for a chart. This column can be used to idenfity the source of a public CSV URL. |
| last_modified_by | Integer | User ID of the last user to modify the chart. This includes changing the position of the chart on the Dashboard. |
| dataset_type | String | (For visuals created with the Data Discovery UI) the dataset origin |
| dataset_id | Integer | View ID or CSV ID corresponding to the dataset used to create the Discovery chart |
| code_language | String | Language used in the code editor - python3.6, python2.7 or r3.2 |
| code | String | Python or R code in the deep analysis editor |
| explore_config | JSON | JSON blob containing the field parameters for Discovery charts |
Views
The Views table lists all views that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those views. This also includes Datasets.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique view ID |
| name | String | View name |
| sql | String | Complete view SQL query text |
| code_language | String | Language used in the code editor - python3.6, python2.7 or r3.2 |
| code | String | Complete view code text |
| created_at | Timestamp | View created timestamp |
| created_by | Integer | View creator user ID |
| updated_at | Timestamp | Last saved view modification timestamp |
| deleted_at | Timestamp | View deleted timestamp |
| owner_id | Integer | View owner user ID |
| space_id | Integer | Space ID for the space that the view is located on |
| last_modified_by | Integer | User ID of the last user to modify the view |
| last_refreshed_at | Timestamp | Timestamp of the last view cache refresh |
| last_used_at | Timestamp | Timestamp of the last time a view was used |
| archived_at | Timestamp | Timestamp of when a view was archived |
| will_archive_at | Timestamp | Timestamp of when a view will archive |
CSVs
The CSVs table lists all CSVs that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those CSVs.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique CSV ID |
| name | String | CSV name |
| file_name | String | Name of the uploaded CSV file |
| created_at | Timestamp | CSV creation timestamp |
| created_by | Integer | CSV creator user ID |
| updated_at | Timestamp | Last saved CSV modification timestamp |
| deleted_at | Timestamp | CSV deleted timestamp |
| owner_id | Integer | CSV owner user ID |
| space_id | Integer | Space ID for the space that the CSV is located on |
| last_used_at | Timestamp | Timestamp of the last use |
| archived_at | Timestamp | Timestamp of when a CSV was archived |
| will_archive_at | Timestamp | Timestamp of when a CSV will archive |
Filters
The filters table lists all filters that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those filters.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique filter ID |
| name | String | Filter name |
| sql | String | Complete filter SQL query text - only if the filter is populated using a query |
| created_at | Timestamp | Filter creation timestamp |
| created_by | Integer | Filter creator user ID |
| updated_at | Timestamp | Last saved filter modification timestamp |
| deleted_at | Timestamp | Filter deleted timestamp |
| space_id | Integer | Space ID for the space that the filter is located on |
| database | String | Name of the database selected in the dropdown list of the edit filter menu |
| last_modified_by | Integer | User ID of the last user to modify the filter |
SQL_Snippets
The SQL Snippets table lists all SQL Snippets that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those SQL Snippets.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique SQL snippet ID |
| name | String | SQL snippet Name |
| owner_id | Integer | SQL snippet owner user ID |
| sql | String | Complete SQL snippet text |
| created_at | Timestamp | SQL snippet creation timestamp |
| created_by | Integer | SQL snippet creator user ID |
| updated_at | Timestamp | Last saved SQL snippet modification timestamp |
| deleted_at | Timestamp | SQL snippet deleted timestamp |
| space_id | Integer | Space ID for the space that the SQL snippet is located on |
SQL_Alerts
The SQL alerts table lists all alerts that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those alerts.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique SQL alert ID |
| name | String | SQL alert Name |
| owner_id | Integer | SQL alert owner user ID |
| sql | String | Complete SQL alert SQL query text |
| created_at | Timestamp | SQL alert creation timestamp |
| updated_at | Timestamp | Last saved SQL alert modification timestamp |
| deleted_at | Timestamp | SQL snippet deleted timestamp |
| space_id | Integer | Space ID for the space that the SQL snippet is located on |
Dashboards
The Dashboards table lists all dashboards that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those dashboards.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique dashboard ID |
| name | String | Dashboard Name |
| created_at | Timestamp | Dashboard created timestamp |
| created_by | Integer | Dashboard creator user ID |
| deleted_at | Timestamp | Dashboard deleted timestamp |
| owner_id | Integer | User ID of the dashboard owner |
| space_id | Integer | Space ID for the space that the dashboard is located on |
| last_used_at | Timestamp | Timestamp of the last time a dashboard was used |
| archived_at | Timestamp | Timestamp of when a dashboard was archived |
| will_archive_at | Timestamp | Timestamp of when a dashboard will archive |
Query_Logs
The query_logs table contains a records for each chart query that was executed on a Sisense for Cloud Data Teams site. This includes chart queries that are initiated by a user as well as chart background refreshes. These logs start from the month Usage Data was enabled from the settings page.
| Field Name | Data Type | Definition |
|---|---|---|
| started_at | Timestamp | Query started to run on the database timestamp |
| created_at | Timestamp | Timestamp of log record creation, when the query has completed |
| user_id | Integer | User ID for the user that triggered the query |
| space_id | Integer | Space that the source of the query is located on |
| item_type | String | Item type of query source - Chart, View, SQL Alert |
| item_id | Integer | ID for query source item - Chart, View, SQL Alert |
| runtime_ms | Integer | Query runtime on the database in milliseconds |
| database_name | String | Name of the database that the query was executed on |
| destination | String | Destination of the query - Cache or origin database |
| hash_key | String | Unique identifier of a query based on its current state (including filters) |
Time_on_Site_Logs
The time_on_site_logs table tracks the duration of time in seconds for which a user is active on a given dashboard. This data is aggregated on an hourly basis. These logs start from the month Usage Data was enabled from the settings page.
| Field Name | Data Type | Definition |
|---|---|---|
| space_id | Integer | Space ID |
| created_at | Timestamp | Aggregated hourly timestamp |
| user_id | Integer | User ID of the user with logged time on the dashboard |
| seconds | Integer | Duration of time in seconds |
| focused_tab | Boolean | Boolean value which defines whether the dashboard browser tab is focused or not |
| dashboard_id | Integer | Dashboard ID |
Users
The users table contains all current users on a Sisense for Cloud Data Teams site as well as the attributes associated with that user.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique user ID |
| first_name | String | User first name |
| last_name | String | User last name |
| email_address | String | User email address |
User_Group_Memberships
The user_group_memberships table contains a record for every user/group combination on a Sisense for Cloud Data Teams site. This table can be used to determine which users are assigned to each user group.
| Field Name | Data Type | Definition |
|---|---|---|
| user_id | Integer | User ID |
| space_id | Integer | Space ID |
| group_id | Integer | Group ID |
| created_at | Timestamp | Group created timestamp |
| deleted_at | Timestamp | Group membership deleted timestamp |
Groups
The groups table contains all groups on a Sisense for Cloud Data Teams site as well as the attributes associated with that group.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique group ID |
| name | String | Group name |
| group_type | String | Type of group - admin, all_user, or custom |
| can_edit | Boolean | Boolean value which defines whether the group has edit access |
| space_id | Integer | Space ID for the space that the group is exists on |
| created_at | Timestamp | Group created timestamp |
| created_by | Integer | Group creator user ID |
| deleted_at | Timestamp | Group deleted timestamp |
Group_Dashboard_Permissions
The group_dashboard_permissions contains a record for every dashboard/group combination on a Sisense for Cloud Data Teams site. This table can be used to determine which groups have access to each dashboard.
| Field Name | Data Type | Definition |
|---|---|---|
| group_id | Integer | Group ID |
| dashboard_id | Integer | Dashboard ID |
| access | String | Level of access that the group has to a dashboard - view or edit |
| created_at | Timestamp | Timestamp that the group permissions were added for a given dashboard |
| updated_at | Timestamp | Timestamp of the last modification to the group permissions to the dashboard |
| deleted_at | Timestamp | Timestamp that the group permissions were removed from the dashboard |
Roles
The roles table contains all roles on a Sisense for Cloud Data Teams site as well as the attributes associated with that roles. This table should be used for sites that have Role-Based Access Control.
| Field Name | Data Type | Definition |
|---|---|---|
| id | String | Unique Role ID |
| name | String | Role name |
| description | String | Description of role |
| is_custom | Boolean | Boolean value which defines whether the role is custom |
| created_at | Timestamp | Role created at timestamp |
| updated_at | Timestamp | Role updated timestamp |
User_Roles
The user_roles table contains a record for every user/role combination on a Sisense for Cloud Data Teams site. This table can be used to determine which users are assigned to each user role. This table should be used for sites that have Role-Based Access Control.
| Field Name | Data Type | Definition |
|---|---|---|
| id | String | Unique User Role ID |
| updated_at | Timestamp | User Role updated timestamp |
| role_id | String | Role ID |
| user_id | String | User ID |
| space_id | String | Space ID |
Role_Privileges
The roles privileges table contains all roles on a Sisense for Cloud Data Teams site as well as the privileges associated with that role. This table should be used for sites that have Role-Based Access Control.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique role ID |
| role_id | String | Role ID |
| Permission_object_type | String | Dashboard or Topic |
| Permission_name | String | Name of permission |
| is_granted | Boolean | Boolean value which defines whether the role is granted the permission |
| space_id | String | Space ID for the space that the role exists on |
| created_at | Timestamp | Role created timestamp |
| updated_at | Timestamp | Role deleted timestamp |
Role_Object_Permissions
The Role_Object_Permissions contains a record for every dashboard/role and topic/role combination on a Sisense for Cloud Data Teams site. This table can be used to determine which roles have access to each dashboard and topic. This table should be used for sites that have Role-Based Access Control.
| Field Name | Data Type | Definition |
|---|---|---|
| id | String | Unique Role Object ID |
| created_at | Timestamp | Timestamp that the role object permissions were added for a given dashboard |
| is_granted | Boolean | Boolean value which defines whether the role is granted the permission |
| permission_id | String | Permission ID |
| permissioned_object_id | String | Permissioned Object ID |
| permissioned_object_type | String | Dashboard or Topic |
| role_id | String | Role ID |
| space_id | String | Space ID |
| updated_at | Timestamp | Timestamp of the last modification to the group permissions to the dashboard |
Spaces
The spaces table contains all spaces on a Sisense for Cloud Data Teams site as well as the attributes associated with that space.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique space ID |
| name | String | Space name |
| created_at | Timestamp | Timestamp of space creation |
| created_by | Integer | User ID of the user that created the space |
| deleted_at | Timestamp | Timestamp of space deletion |
Table_Cache_Logs
The table_cache_logs table contains a history of when tables cached, duration, and cache strategy. This includes tables that successfully cached as well as tables that failed. Unusually short cache cycle times - the difference between cache_started_at and cache_completed_at - likely indicate an incremental update that did not identify any new rows to be added.
| Field Name | Data Type | Definition |
|---|---|---|
| space_id | Integer | Space ID of the space that the table is cached on |
| database_name | String | Name of the cached origin database of the cached table |
| schema_name | String | Name of the scheme on the origin database of the cached table |
| table_name | String | Name of the cached table |
| cache_strategy | string | Chosen caching strategy - Bounded, Incremental, Bounded, Null |
| cache_started_at | Timestamp | Timestamp of the cache query beginning |
| cache_completed_at | Timestamp | Time of the cache process completing |
| error | Boolean | Boolean that defines whether the cache process returned an error |
View_Cache_Logs
The view_cache_logs table contains a history of when views materialized as well as their duration. Views that successfully materialized as well as views that failed to cache are included.
| Field Name | Data Type | Definition |
|---|---|---|
| space_id | Integer | Space ID of the space that the view exists on |
| database_name | String | Database selected in the database dropdown of the schema browser in the view editor |
| view_id | Integer | View ID |
| cache_started_at | Timestamp | Timestamp of the materialization query beginning |
| cache_completed_at | Timestamp | Time of the materialization process completing |
| error | boolean | Boolean that defines whether the materialization process returned an error |
| created_at | Timestamp | Timestamp at which the most recent materialization process ends |
Urls
The urls table contains a list of urls for all chart and dashboard items on a Sisense for Cloud Data Teams site.
| Field Name | Data Type | Definition |
|---|---|---|
| item_id | String | ID of the Periscope Item. This corresponds to the charts.id column for chart items and dashboards.id for dashboard items |
| item_type | String | Defines the item type - dashboard, chart |
| url | String | URL to the in-app item. Access to the URL does require Periscope login credentials. |
Deprecated Tables
The below tables are deprecated. They will continue to be populated as normal to avoid disrupting charts that use them, however the specified matching tables should be used going forward.
SQL_Views
This table is the old version of the Views table listed above. The SQL_Views table lists all views that have been created on a Sisense for Cloud Data Teams site as well as the attributes associated with those views. This also includes Datasets.
| Field Name | Data Type | Definition |
|---|---|---|
| id | Integer | Unique view ID |
| name | String | View name |
| sql | String | Complete view SQL query text |
| created_at | Timestamp | View created timestamp |
| created_by | Integer | View creator user ID |
| updated_at | Timestamp | Last saved view modification timestamp |
| deleted_at | Timestamp | View deleted timestamp |
| owner_id | Integer | View owner user ID |
| space_id | Integer | Space ID for the space that the view is located on |
| last_modified_by | Integer | User ID of the last user to modify the view |
| last_refreshed_at | Timestamp | Timestamp of the last view cache refresh |
| last_used_at | Timestamp | Timestamp of the last time a view was used |
| archived_at | Timestamp | Timestamp of when a view was archived |
| will_archive_at | Timestamp | Timestamp of when a view will archive |
SQL_View_Cache_Logs
This table is the old version of the View_Cache_Logs table listed above. The SQL_View_Cache_Logs table contains a history of when views materialized as well as their duration. Views that successfully materialized as well as views that failed to cache are included.
| Field Name | Data Type | Definition |
|---|---|---|
| space_id | Integer | Space ID of the space that the view exists on |
| database | String | Database selected in the database dropdown of the schema browser in the view editor |
| sql_view_id | Integer | View ID |
| cache_started_at | Timestamp | Timestamp of the materialization query beginning |
| cache_completed_at | Timestamp | Time of the materialization process completing |
| error | boolean | Boolean that defines whether the materialization process returned an error |
