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.

<div><UL>
<LI><a href="#Charts">Charts</a></LI>
<LI><a href="#Views">Views</a></LI>
<LI><a href="#CSVs">CSVs</a></LI>
<LI><a href="#Filters">Filters</a></LI>
<LI><a href="#SQL_Snippets">SQL_Snippets</a></LI>
<LI><a href="#SQL_Alerts">SQL_Alerts</a></LI>
<LI><a href="#Dashboards">Dashboards</a></LI>
<LI><a href="#Query_Logs">Query_Logs</a></LI>
<LI><a href="#Time_on_Site_Logs">Time_on_Site_Logs</a></LI>
<LI><a href="#Users">Users</a></LI>
<LI><a href="#User_Group_Membership">User_Group_Memberships</a></LI>
<LI><a href="#Groups">Groups</a></LI>
<LI><a href="#Group_Dashboard_Permissions">Group_Dashboard_Permissions</a></LI>
<LI><a href="#Roles">Roles</a></LI>
<LI><a href="#User_Roles">User_Roles</a></LI>
<LI><a href="#Role_Privileges">Role_Privileges</a></LI>
<LI><a href="#Role_Object_Permissions">Role_Object_Permissions</a></LI>
<LI><a href="#Spaces">Spaces</a></LI>
<LI><a href="#Table_Cache_Logs">Table_Cache_Logs</a></LI>
<LI><a href="#View_Cache_Logs">View_Cache_Logs</a></LI>
<LI><a href="#Urls">Urls</a></LI>
<LI><a href="#Deprecated">Deprecated Tables</a></LI>
<UL>
<LI><a href="#SQL_Views">SQL_Views</a></LI>
<LI><a href="#SQL_View_Cache_Logs">SQL_View_Cache_Logs</a></LI>
</UL>
</UL></div>
<HR>

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.

<div><table><thead><tr><th style="width:200px;text-align:left">Field Name</th><th style="width:200px;text-align:left">Data Type</th><th style="width:300px;text-align:left">Definition</th></tr></thead><tbody> <tr><td>id</td><td>Integer</td><td>Unique chart ID</td></tr><tr><td>name</td><td>String</td><td>Chart name</td></tr><tr><td>sql</td><td>String</td><td>Complete chart SQL query text</td></tr><tr><td>created_at</td><td>Timestamp</td><td>Chart created timestamp</td></tr><tr><td>created_by</td><td>Integer</td><td>Chart creator user ID</td></tr><tr><td>updated_at</td><td>Timestamp</td><td>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.</td></tr><tr><td>deleted_at</td><td>Timestamp</td><td>Chart deleted timestamp</td></tr><tr><td>dashboard_id</td><td>Integer</td><td>Dashboard ID for the dashboard the chart is located on</td></tr><tr><td>space_id</td><td>Integer</td><td>Space ID for the space that the chart is located on</td></tr><tr><td>database_name</td><td>String</td><td>Name of the database selected in the chart editor dropdown list</td></tr><tr><td>csv_url_token</td><td>String</td><td>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. </td></tr><tr><td>last_modified_by</td><td>Integer</td><td>User ID of the last user to modify the chart. This includes changing the position of the chart on the Dashboard.</td></tr><tr><td>dataset_type</td><td>String</td><td>(For visuals created with the Data Discovery UI) the dataset origin</td></tr><tr><td>dataset_id</td><td>Integer</td><td>View ID or CSV ID corresponding to the dataset used to create the Discovery chart</td></tr><tr><td>code_language</td><td>String</td><td>Language used in the code editor - python3.6, python2.7 or r3.2</td></tr><tr><td>code</td><td>String</td><td>Python or R code in the deep analysis editor</td></tr><tr><td>explore_config</td><td>JSON</td><td>JSON blob containing the field parameters for Discovery charts</td></tr></tbody></table></div>‍<a href="#top">Back to top</a>

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.

<table><thead><tr><th style="width:200px;text-align:left">Field Name</th><th style="width:200px;text-align:left">Data Type</th><th style="width:300px;text-align:left">Definition</th></tr></thead><tbody><tr><td>id</td><td>Integer</td><td>Unique view ID</td></tr><tr><td>name</td><td>String</td><td>View name</td></tr><tr><td>sql</td><td>String</td><td>Complete view SQL query text</td></tr><tr><td>code_language</td><td>String</td><td>Language used in the code editor - python3.6, python2.7 or r3.2</td></tr><tr><td>code</td><td>String</td><td>Complete view code text</td></tr><tr><td>created_at</td><td>Timestamp</td><td>View created timestamp</td></tr><tr><td>created_by</td><td>Integer</td><td>View creator user ID</td></tr><tr><td>updated_at</td><td>Timestamp</td><td>Last saved view modification timestamp</td></tr><tr><td>deleted_at</td><td>Timestamp</td><td>View deleted timestamp</td></tr><tr><td>owner_id</td><td>Integer</td><td>View owner user ID</td></tr><tr><td>space_id</td><td>Integer</td><td>Space ID for the space that the view is located on</td></tr><tr><td>last_modified_by</td><td>Integer</td><td>User ID of the last user to modify the view</td></tr><tr><td>last_refreshed_at</td><td>Timestamp</td><td>Timestamp of the last view cache refresh</td></tr><tr><td>last_used_at</td><td>Timestamp</td><td>Timestamp of the last time a view was used</td></tr><tr><td>archived_at</td><td>Timestamp</td><td>Timestamp of when a view was archived</td></tr><tr><td>will_archive_at</td><td>Timestamp</td><td>Timestamp of when a view will archive</td></tr></tbody></table><a href="#top">Back to top</a>

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.

<table><thead><tr><th style="width:200px;text-align:left">Field Name</th><th style="width:200px;text-align:left">Data Type</th><th style="width:300px;text-align:left">Definition</th></tr></thead><tbody> <tr><td>id</td><td>Integer</td><td>Unique CSV ID</td></tr><tr><td>name</td><td>String</td><td>CSV name</td></tr><tr><td>file_name</td><td>String</td><td>Name of the uploaded CSV file</td></tr><tr><td>created_at</td><td>Timestamp</td><td>CSV creation timestamp</td></tr><tr><td>created_by</td><td>Integer</td><td>CSV creator user ID</td></tr><tr><td>updated_at</td><td>Timestamp</td><td>Last saved CSV modification timestamp</td></tr><tr><td>deleted_at</td><td>Timestamp</td><td>CSV deleted timestamp</td></tr><tr><td>owner_id</td><td>Integer</td><td>CSV owner user ID</td></tr><tr><td>space_id</td><td>Integer</td><td>Space ID for the space that the CSV is located on</td></tr><tr><td>last_used_at</td><td>Timestamp</td><td>Timestamp of the last use</td></tr><tr><td>archived_at</td><td>Timestamp</td><td>Timestamp of when a CSV was archived</td></tr><tr><td>will_archive_at</td><td>Timestamp</td><td>Timestamp of when a CSV will archive</td></tr></tbody></table>
<a href="#top">Back to top</a>

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.

<table><thead><tr><th style="width:200px;text-align:left">Field Name</th><th style="width:200px;text-align:left">Data Type</th><th style="width:300px;text-align:left">Definition</th></tr></thead><tbody> <tr><td>id</td><td>Integer</td><td>Unique filter ID</td></tr><tr><td>name</td><td>String</td><td>Filter name</td></tr><tr><td>sql</td><td>String</td><td>Complete filter SQL query text - only if the filter is populated using a query </td></tr><tr><td>created_at</td><td>Timestamp</td><td>Filter creation timestamp</td></tr><tr><td>created_by</td><td>Integer</td><td>Filter creator user ID</td></tr><tr><td>updated_at</td><td>Timestamp</td><td>Last saved filter modification timestamp</td></tr><tr><td>deleted_at</td><td>Timestamp</td><td>Filter deleted timestamp</td></tr><tr><td>space_id</td><td>Integer</td><td>Space ID for the space that the filter is located on</td></tr><tr><td>database</td><td>String</td><td>Name of the database selected in the dropdown list of the edit filter menu</td></tr><tr><td>last_modified_by</td><td>Integer</td><td>User ID of the last user to modify the filter</td></tr></tbody></table>
<a href="#top">Back to top</a>

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.

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.

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.

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.

<table><thead><tr><th style="width:200px;text-align:left">Field Name</th><th style="width:200px;text-align:left">Data Type</th><th style="width:300px;text-align:left">Definition</th></tr></thead><tbody> <tr><td>started_at</td><td>Timestamp</td><td>Query started to run on the database timestamp</td></tr><tr><td>created_at</td><td>Timestamp</td><td>Timestamp of log record creation, when the query has completed</td></tr><tr><tr><td>user_id</td><td>Integer</td><td>User ID for the user that triggered the query</td></tr><tr><td>space_id</td><td>Integer</td><td>Space that the source of the query is located on</td></tr><tr><td>item_type</td><td>String</td><td>Item type of query source - Chart, View, SQL Alert</td></tr><tr><tr><td>item_id</td><td>Integer</td><td>ID for query source item - Chart, View, SQL Alert</td></tr><tr><td>runtime_ms</td><td>Integer</td><td>Query runtime on the database in milliseconds</td></tr><tr><td>database_name</td><td>String</td><td>Name of the database that the query was executed on</td></tr><tr><td>destination</td><td>String</td><td>Destination of the query - Cache or origin database</td></tr><tr><td>hash_key</td><td>String</td><td>Unique identifier of a query based on its current state (including filters)</td></tr></tbody></table>
<a href="#top">Back to top</a>

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.

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.

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.

Groups

The groups table contains all groups on a Sisense for Cloud Data Teams site as well as the attributes associated with that group.

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.

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.

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.

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.

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.

Spaces

The spaces table contains all spaces on a Sisense for Cloud Data Teams site as well as the attributes associated with that space.

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.

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.

Urls

The urls table contains a list of urls for all chart and dashboard items on a Sisense for Cloud Data Teams site.

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.

<table><thead><tr><th style="width:200px;text-align:left">Field Name</th><th style="width:200px;text-align:left">Data Type</th><th style="width:300px;text-align:left">Definition</th></tr></thead><tbody> <tr><td>id</td><td>Integer</td><td>Unique view ID</td></tr><tr><td>name</td><td>String</td><td>View name</td></tr><tr><td>sql</td><td>String</td><td>Complete view SQL query text</td></tr><tr><td>created_at</td><td>Timestamp</td><td>View created timestamp</td></tr><tr><td>created_by</td><td>Integer</td><td>View creator user ID</td></tr><tr><td>updated_at</td><td>Timestamp</td><td>Last saved view modification timestamp</td></tr><tr><td>deleted_at</td><td>Timestamp</td><td>View deleted timestamp</td></tr><tr><td>owner_id</td><td>Integer</td><td>View owner user ID</td></tr><tr><td>space_id</td><td>Integer</td><td>Space ID for the space that the view is located on</td></tr><tr><td>last_modified_by</td><td>Integer</td><td>User ID of the last user to modify the view</td></tr><tr><td>last_refreshed_at</td><td>Timestamp</td><td>Timestamp of the last view cache refresh</td></tr><tr><td>last_used_at</td><td>Timestamp</td><td>Timestamp of the last time a view was used</td></tr><tr><td>archived_at</td><td>Timestamp</td><td>Timestamp of when a view was archived</td></tr><tr><td>will_archive_at</td><td>Timestamp</td><td>Timestamp of when a view will archive</td></tr></tbody></table>
<a href="#top">Back to top</a>

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.

Thank you! Your submission has been received!

Oops! Something went wrong while submitting the form