Entity Snapshots Reference

This topic describes the entity snapshot tables and fields available through the Tableau Cloud Manager REST API. For more information about entity snapshots, see Use Entity Snapshots and Platform Data(Link opens in a new window).

Entity snapshot tables

Use the alphabetically sorted list of entity tables on the right, or ctrl/cmd-f to go directly to keywords you have in mind.

Note: Timestamps are recorded in ISO 8601 UTC.

capabilities

The capabilities entity type contains information about the capabilities that can be granted or denied by permissions.

Field NameTypeDescription
descriptionstringA description of what the capability allows a user to do.
display_namestringThe name of the capability as it appears to users.
display_orderintegerThe order in which capabilities are listed in the interface.
IDintegerThe unique identifier for the record.
namestringThe name or ID used to refer to the capability in code.
site_luidstringThe LUID of the site.

data_connections

The data_connections entity type contains information about the connections used by workbooks and data sources.

Field NameTypeDescription
authenticationstringThe authentication method used for the data connection.
captionstringThe name of the connection as it appears in the Data pane.
cloud_file_request_urlstringThe request URL for a cloud file associated with the data connection. This value can be null.
created_attimestampThe date and time this record was created.
datasource_idintegerThe ID of the data source that owns this data connection.
db_subclassstringA subclass of the database class. For example, if the database class is web-data-direct, the subclass is intuit-quickbook.
dbclassstringThe type of data connection, such as MySQL, PostgreSQL or SQL proxy.
dbnamestringThe name of the database for this connection.
has_extractbooleanIndicates whether the data connection is an extract.
IDintegerThe unique identifier for the record.
keychainstringAn encoded string in YAML format.
luiduuidThe unique identifier used to identify the connection in the Tableau REST API. Tableau automatically generates this value.
namestringThe unique name for the data connection.
owner_idintegerThe ID of the workbook or data source that created the data connection.
owner_typestringThe type of content that created the data connection. Either workbook or data source.
passwordbooleanIndicates whether the password is embedded in the owner.
portintegerThe port number for the connection.
query_tagging_enabledbooleanIndicates whether queries for this data connection are tagged with information about their origin in Tableau.
serverstringThe name of the server for the connection.
site_idintegerThe ID of the site where the data connection is located.
site_luidstringThe LUID of the site.
statestringThe publication state. Either active or archived.
tablenamestringThe name of the database table for the connection.
updated_attimestampThe date and time the record was last updated.
usernamestringThe username used for the connection.
using_remote_query_agentbooleanIndicates whether the data connection uses Tableau Bridge.

datasources

The datasources entity type contains information about published data sources.

Field NameTypeDescription
certification_notestringThe explanation for the certification status.
certifier_detailsstringA snapshot of the certifier information.
certifier_user_idintegerThe ID of the user who certified the data source. This value is null if the data source isn’t certified.
connectablebooleanIndicates whether the data source supports connections through Data Server.
content_versionintegerThe version number of the data source updated with each publication.
created_attimestampThe date and time this record was created.
data_engine_extractsbooleanIndicates whether the data is provided as a Tableau data extract.
db_classstringThe type of data connection, such as Excel or Oracle.
db_namestringThe name of the database or the file path for the data source.
descriptionstringA description of the data source.
document_versionstringThe internal version of the .tds file for this record.
extracts_incremented_attimestampThe date and time of the last incremental extract refresh.
extracts_refreshed_attimestampThe date and time of the last full extract refresh.
first_published_attimestampThe date and time the data source was first published.
hidden_namestringThe auto-generated name for the data source extracted from the file.
IDintegerThe unique identifier for the record.
incrementable_extractsbooleanIndicates whether incremental extracts are allowed for the published data source.
is_certifiedbooleanIndicates whether the data source is certified.
is_hierarchicalbooleanIf true, the source is a hierarchical (cube) database.
last_published_attimestampThe date and time the data source was last published.
luidstringThe unique identifier for the data source.
modified_by_user_idintegerThe ID of the user who last modified and published the data source. For older records, this value is the same as owner_id.
namestringThe name of the published data source.
owner_idintegerThe user ID of the owner or uploader of the data source.
parent_typestringThe parent type of the data source. Either datarole, workbook or null.
parent_workbook_idintegerThe ID of the workbook that contains this data source. This is null for published data sources.
refreshable_extractsbooleanIndicates whether refreshable extracts are available for the published data source.
remote_query_agent_idintegerThe ID of the agent used for remote queries.
repository_urlstringA unique name for the data source used in URLs.
revisionstringThe version number of the data source, which increments each time it is published.
site_idintegerThe ID of the site associated with the data source.
site_luidstringThe LUID of the site.
sizelongThe size of the data source in bytes.
statestringThe publication state. Either active or archived.
table_namestringThe name of the table or worksheet associated with the published data source.
updated_attimestampThe date and time the record was last updated.
using_remote_query_agentbooleanIndicates whether queries to this data source use a remote agent.

flows

The flows entity type contains information about published flows.

Field NameTypeDescription
content_versionintegerThe version number of the flow updated with each publication.
created_attimestampThe date and time this record was created.
data_engine_extractsbooleanIndicates whether the data is provided as a Tableau data extract.
descriptionstringThe description of the flow.
document_versionstringThe internal version of the .tfl file for this record.
file_typestringThe file type. Either .tfl or .tflx.
hiddenbooleanIndicates whether the flow is hidden from the content management system.
IDintegerThe unique identifier for the flow.
is_deletedbooleanIndicates whether the flow is in the Recycle Bin. Deleted flows aren’t visible to active jobs or user requests until restored.
kindstringThe type of flow.
last_published_attimestampThe date and time the flow was last published.
luiduuidThe unique identifier for the flow.
namestringThe name of the published flow.
owner_idintegerThe user ID of the owner or publisher of the flow.
project_idintegerThe ID of the project associated with the flow.
site_idintegerThe ID of the site associated with the flow.
site_luidstringThe LUID of the site.
sizelongThe size of the flow file in bytes.
statestringThe state of the flow. Either active or archived. The default is active.
updated_attimestampThe date and time the record was last updated.

group_users

The group_users entity type contains information about the users assigned to groups.

Field NameTypeDescription
group_idintegerThe ID of the group.
IDintegerThe unique identifier for the record.
site_idintegerThe ID of the site for the group users.
site_luidstringThe LUID of the site.
user_idintegerThe ID of the user.

groups

The groups entity type contains information about user groups.

Field NameTypeDescription
created_attimestampThe date and time this record was created.
domain_idintegerThe ID of the domain associated with the group.
external_user_enabledbooleanIndicates whether external users can be added to the group.
grant_license_modestringIndicates when to grant a licence to group members. Either ON_SYNC or ON_LOGIN.
IDintegerThe unique identifier for the record.
last_synchronisedtimestampThe date and time the Active Directory group was last synchronised.
luiduuidAn identifier that is unique when combined with the site ID.
minimum_site_rolestringThe minimum site role assigned to members of the Active Directory group.
minimum_site_role_idintegerThe ID of the minimum site role for the group.
namestringThe name of the group.
owner_idintegerThe ID of the user who owns the group.
site_idintegerThe ID of the site the group belongs to.
site_luidstringThe LUID of the site.
systembooleanIndicates whether the group was created by Tableau or a user.
updated_attimestampThe date and time the record was last updated.

next_gen_permissions

The next_gen_permissions entity type contains information about permissions assigned to users, groups and groupsets.

Field NameTypeDescription
authorisable_idintegerThe ID of the content for which permissions are specified.
authorisable_typestringThe type of content for which permissions are specified. Either Project, Workbook, DataSource, View or NamedResource.
capability_idintegerThe ID of the capability being granted or denied.
grantee_idintegerThe ID of the user, group or groupset being granted permissions.
grantee_typestringThe type of grantee. Either User, Group or GroupAND.
IDintegerThe unique identifier for the record.
permissionintegerThe permission level indicating whether the capability is granted or denied to a user or group. The value 1 = grant to group, 2 = deny to group, 3 = grant to user and 4 = deny to user. Higher values take precedence. For example, a user-specific grant can override a group-level deny.
site_idintegerThe ID of the site where the permissions belong.
site_luidstringThe LUID of the site.

projects

The projects entity type contains information about projects used to organise content.

Field NameTypeDescription
admin_insights_enabledbooleanIndicates whether the project is an Admin Insights project.
controlled_permissions_enabledbooleanIndicates whether permissions are controlled at the project level.
controlling_permissions_project_idintegerThe ID of the ancestor project that controls permissions for this project.
created_attimestampThe date and time this record was created.
descriptionstringA description of the project.
IDintegerThe unique identifier for the record.
luiduuidThe unique identifier for the record.
namestringThe name of the project.
nested_projects_permissions_includedbooleanIndicates whether permissions for nested projects are controlled at the project level.
owner_idintegerThe ID of the user who owns the project.
parent_project_idintegerThe ID of the parent project. This is null for top-level projects.
site_idintegerThe ID of the site that contains the project.
site_luidstringThe LUID of the site.
specialintegerIndicates whether this is a system-created project, such as the Default project. The value is 1 for system-created projects. Otherwise, the value is null.
statestringThe state of the project. Either active or inactive.
updated_attimestampThe date and time the record was last updated.

projects_contents

The projects_contents entity type contains information about content stored in projects.

Field NameTypeDescription
content_idintegerThe ID of the content stored in the project, denoted by project_id. Use with content_type to uniquely identify the content.
content_typestringThe type of content in the project. Use with content_id to uniquely identify the content.
IDintegerThe unique identifier for the record.
project_idintegerThe ID of the project associated with the record.
site_idintegerThe ID of the site associated with the record.
site_luidstringThe LUID of the site.

published_connection_revision_tables

The published_connection_revision_tables entity type contains information about tables associated with published connection revisions.

Field NameTypeDescription
created_attimestamp without time zoneThe date and time this record was created.
IDintegerThe unique identifier for the record.
published_connection_table_luiduuidThe ID of the associated published connection table.
revisable_propertiesjsonbProperties that users can revise.
revision_idintegerThe ID of the associated revision.
site_idintegerThe ID of the associated site.
site_luidstringThe LUID of the site.
system_propertiesjsonbSystem metadata.
updated_attimestamp without time zoneThe date and time the record was last updated.

published_connection_revisions

The published_connection_revisions entity type contains information about revisions of published connections.

Field NameTypeDescription
created_attimestamp without time zoneThe date and time this record was created.
IDintegerThe unique identifier for the record.
luiduuidThe unique identifier for the revision within a site.
owner_idintegerThe ID of the user who owns the revision.
published_attimestamp without time zoneThe date and time this revision was published.
published_connection_idintegerThe ID of the associated published connection.
revisable_propertiesjsonbProperties that users can revise.
revisable_properties_updated_attimestamp without time zoneThe date and time the revisable properties were last updated.
revisable_properties_versionintegerA number that increments each time revisable properties are updated.
revision_typeintegerThe type of revision. The value 0 = draft, 1 = active, 2 = historical.
site_idintegerThe ID of the associated site.
site_luidstringThe LUID of the site.
system_propertiesjsonbSystem metadata.
updated_attimestamp without time zoneThe date and time the record was last updated.
version_numberintegerThe incrementing version number for the revision.

published_connection_tables

The published_connection_tables entity type contains information about tables associated with published connections.

Field NameTypeDescription
created_attimestamp without time zoneThe date and time this record was created.
descriptionstringThe description of the published connection table.
IDintegerThe unique identifier for the record.
luiduuidThe unique identifier for the table within a site.
namestringThe name of the published connection table.
published_connection_idintegerThe ID of the associated published connection.
site_idintegerThe ID of the associated site.
site_luidstringThe LUID of the site.
updated_attimestamp without time zoneThe date and time the record was last updated.

published_connections

The published_connections entity type contains information about published connections.

Field NameTypeDescription
activatedbooleanIndicates whether the published connection was made available for use.
created_attimestampThe date and time this record was created.
descriptionstringThe description of the published connection.
IDintegerThe unique identifier for the record.
luiduuidThe unique identifier for the connection within a site.
namestringThe name of the published connection.
owner_idintegerThe ID of the user who owns the connection.
project_idintegerThe ID of the associated project.
site_idintegerThe ID of the associated site.
site_luidstringThe LUID of the site.
updated_attimestampThe date and time the record was last updated.

schedules

The schedules entity type contains information about schedules used to run tasks.

Field NameTypeDescription
actionablebooleanIndicates whether the schedule is actionable.
activebooleanIndicates whether the schedule is active. If false, no tasks run when the schedule triggers.
created_attimestamp without time zoneThe date and time this record was created.
day_of_month_maskintegerAn encoded value that indicates the days of the month on which the schedule runs. Convert the value to binary to interpret it, where each binary position represents a day of the month. The value 1 = 1st, 10 = 2nd, 100 = 3rd and so on.
day_of_week_maskintegerAn encoded value that indicates the days of the week on which the schedule runs. Convert the value to binary to interpret it, where each binary position represents a day of the week. The value 1 = Sunday, 10 = Monday, 100 = Tuesday, 1,000 = Wednesday, 10,000 = Thursday, 100,000 = Friday, 1,000,000 = Saturday.
defined_byintegerThe type of mechanism that created the schedule, such as 0 for system administrator and 1 for self-service.
end_at_minuteintegerThe minute the schedule stops triggering within its frequency period.
end_schedule_attimestamp without time zoneThe date and time after which the schedule no longer triggers.
hiddenbooleanIndicates whether the schedule is visible in the interface.
IDintegerThe unique identifier for the record.
linked_task_enabledbooleanIndicates whether users can create linked tasks on this schedule.
luiduuidThe unique identifier for the schedule used in the REST API.
minute_intervalintegerThe interval at which the schedule retriggers after starting. Defined by schedule_type, end_at_minute or end_schedule_at.
namestringThe name of the schedule.
priorityintegerThe priority of the schedule from 1 (highest) to 100 (lowest).
run_next_attimestamp without time zoneThe date and time the schedule will next trigger.
schedule_typeintegerThe frequency of the schedule. The value 0 = Hourly, 1 = Daily, 2 = Weekly and 3 = Monthly.
scheduled_actionintegerThe type of task assigned to the schedule. The value 0 = Extracts, 1 = Subscriptions, 2 = Active Directory synchronisation, 3 = Auto Refresh Extracts and 4 = Flows.
serial_collection_idintegerThe ID used to prevent simultaneous processing of linked jobs. Jobs with the same serial_collection_id can’t run at the same time.
site_luidstringThe LUID of the site.
start_at_minuteintegerThe minute the schedule starts within its frequency period. For example, with a daily schedule, this is the number of minutes past midnight.
timezoneidstringThe IANA time zone for the schedule, such as America/Los_Angeles.
updated_attimestamp without time zoneThe date and time the record was last updated.

subscriptions

The subscriptions entity type contains information about subscriptions configured for users.

Field NameTypeDescription
attach_imagebooleanIndicates whether to attach images to the subscription email.
attach_pdfbooleanIndicates whether to attach a PDF to the subscription email.
content_has_user_referencesbooleanIndicates whether the subscription content includes user references. Null means the subscription hasn’t run yet.
created_attimestamp without time zoneThe date and time this record was created.
creator_idintegerThe ID of the user who created the subscription.
data_condition_typestringThe type of data condition that triggers the subscription. The default is Always. Other values include DataPresent, Constant, Band and more.
IDintegerThe unique identifier for the record.
is_refresh_extract_triggeredbooleanIndicates whether the subscription is triggered by an extract refresh.
last_senttimestamp without time zoneThe date and time the subscription was last sent.
luiduuidThe unique identifier for the subscription used in the REST API.
schedule_idintegerThe ID of the schedule that triggers the subscription.
site_idintegerThe ID of the site where the subscription is located.
site_luidstringThe LUID of the site.
subjectstringThe subject line or description of the subscription.
subscription_message_idintegerThe ID for the subscription message.
target_idintegerThe ID of the content being subscribed to.
target_typestringThe type of content being subscribed to. Either View or Workbook.
user_idintegerThe ID of the user who receives the subscription.

system_users

The system_users entity type contains information about system-level user accounts.

Field NameTypeDescription
admin_levelintegerIndicates whether the user is a system administrator. The value 10 = system administrator and 0 = not a system administrator.
created_attimestamp without time zoneThe date and time this record was created.
custom_display_namebooleanIndicates whether to prevent the friendly name from being overwritten by Active Directory.
domain_idintegerThe ID of the domain for the user.
emailstringThe user’s email address.
failed_login_attemptsintegerThe number of failed login attempts since the last successful login.
force_password_updatebooleanIndicates whether the user must reset their password at the next login.
friendly_namestringThe name used in the interface to refer to the user.
IDintegerThe unique identifier for the record.
last_failed_logintimestamp without time zoneThe date and time of the user’s last unsuccessful login.
last_password_updatetimestamp without time zoneThe date and time the user last updated their password.
namestringThe username.
site_luidstringThe LUID of the site.
updated_attimestamp without time zoneThe date and time the record was last updated.

taggings

The taggings entity type contains information about the relationship between tags and tagged content.

Field NameTypeDescription
IDintegerThe unique identifier for the record.
site_idintegerThe ID of the site the tagging belongs to.
site_luidstringThe LUID of the site.
tag_idintegerThe ID of the tag.
taggable_idintegerThe ID of the tagged item.
taggable_typestringThe type of item being tagged. This value identifies which table to join to.
user_idintegerThe ID of the user who owns the tag.

tags

The tags entity type contains information about tags used to label content.

Field NameTypeDescription
created_attimestamp without time zoneThe date and time this record was created.
IDintegerThe unique identifier for the record.
namestringThe name of the tag.
site_idintegerThe ID of the site the tag belongs to.
site_luidstringThe LUID of the site.
updated_attimestamp without time zoneThe date and time the record was last updated.

tasks

The tasks entity type contains information about scheduled tasks.

Field NameTypeDescription
activebooleanIndicates whether the task is active. If false, the task doesn’t run when the schedule triggers.
argsstringTask parameters formatted as YAML.
consecutive_failure_countintegerThe number of times this task has failed.
created_attimestamp without time zoneThe date and time this record was created.
creator_idintegerThe ID of the user who created the task.
historical_queue_timeintegerThe historical queue time of the task in seconds.
historical_run_timeintegerThe historical run time of the task in seconds.
IDintegerThe unique identifier for the table.
last_success_completed_attimestamp without time zoneThe date and time the task was last completed successfully.
luiduuidThe unique identifier for the task used in the REST API.
obj_idintegerThe ID of the workbook or data source associated with the task.
obj_typestringThe type of object associated with the task. Either Workbook or Data Source. Use with obj_id to uniquely identify the object.
priorityintegerThe priority of the task where 0 is the highest priority and 10 is the default.
run_countintegerThe number of times this task has run since this field was added. This value might not be accurate for tasks created before the field existed.
schedule_idintegerThe ID of the schedule linked to the task. When the schedule’s run_next_at time arrives, linked tasks run.
site_idintegerThe ID of the site associated with the task. Used for site-specific tasks.
site_luidstringThe LUID of the site.
stateintegerThe current state of the task. The value 0 = active, 1 = suspended and 2 = disabled.
subtitlestringAdditional information about the task.
titlestringAdditional information about the task.
typestringThe type of task.
updated_attimestamp without time zoneThe date and time the record was last updated.

users

The users entity type contains information about site users.

Field NameTypeDescription
created_attimestamp without time zoneThe date and time this record was created.
IDintegerThe unique identifier for the record.
login_attimestamp without time zoneThe date and time of the user’s most recent login.
luiduuidThe unique identifier for the record.
site_idintegerThe ID of the site the user belongs to.
site_luidstringThe LUID of the site.
site_role_idintegerThe ID of the site role for the user. The value 0 = SiteAdministrator, 1 = SupportUser, 2 = Publisher, 3 = Interactor, 4 = ViewerWithPublish, 5 = Viewer, 6 = UnlicensedWithPublish, 7 = Guest, 8 = Unlicensed and 9 = BasicUser.
system_admin_autobooleanIndicates whether the user is a system administrator not explicitly assigned to the site.
system_user_idintegerThe ID of the system user associated with this user.
updated_attimestamp without time zoneThe date and time the record was last updated.

views

The views entity type contains information about views in workbooks.

Field NameTypeDescription
captionstringThe description of the worksheet based on the workbook definition.
created_attimestamp without time zoneThe date and time this record was created.
descriptionstringThe description of the view.
fieldsstringThe fields extracted from the workbook’s .twb file.
first_published_attimestamp without time zoneThe date and time the view was first published. This value doesn’t change if the workbook containing the view is republished.
IDintegerThe unique identifier for the record.
indexintegerThe index number of the view within its workbook.
is_deletedbooleanIndicates whether the view is in the Recycle Bin.
luiduuidThe unique identifier for the record.
namestringThe name of the view.
owner_idintegerThe ID of the user who owns the view.
repository_urlstringA unique name for the view used in URLs.
revisionstringThe version number of the view. The value starts at 1.0 and increments by 0.1 with each republication
sheet_idstringThe identifier for the sheet.
sheettypestringThe type of sheet. Either story, dashboard or view.
site_idintegerThe ID of the site the view belongs to.
site_luidstringThe LUID of the site.
statestringThe state of the view. Either active or disabled.
titlestringThe title of the worksheet extracted from the workbook’s .twb file.
updated_attimestamp without time zoneThe date and time the record was last updated.
workbook_idintegerThe ID of the workbook that contains the view.

workbooks

The workbooks entity type contains information about published workbooks.

Field NameTypeDescription
content_versionintegerThe version number of the workbook updated with each publication.
created_attimestampThe date and time this record was created.
data_engine_extractsbooleanIndicates whether the workbook has associated data engine extracts.
default_view_indexintegerIndicates which view is shown by default.
display_tabsbooleanIf true, sheets appear as tabs in the workbook.
document_versionstringThe version of the document description used when the workbook was saved.
first_published_attimestampThe date and time the workbook was first published. This value doesn’t change when the workbook is republished.
IDintegerThe unique identifier for the record.
incrementable_extractsbooleanIndicates whether incremental extract refreshes are possible for this workbook.
is_deletedbooleanIndicates whether the workbook is in the Recycle Bin. Deleted workbooks aren’t visible to active jobs or user requests until restored.
last_published_attimestampThe date and time the workbook was last published.
luiduuidThe unique identifier for the record.
modified_by_user_idintegerThe ID of the user who last modified and published the workbook. For older records, this value is the same as owner_id.
namestringThe name of the workbook.
owner_idintegerThe ID of the user who owns this workbook.
published_all_sheetsbooleanIndicates whether all sheets in the workbook were published.
refreshable_extractsbooleanIndicates whether extracts in the workbook can be refreshed.
repository_urlstringA unique name for the workbook used in URLs.
revisionstringThe version number of the workbook. The value starts at 1.0 and increments by 0.1 with each republication
site_idintegerThe ID of the site where the workbook was published.
site_luidstringThe LUID of the site.
sizebigintThe size of the workbook in bytes.
thumb_userintegerThe ID of the user used to generate the thumbnail image. This value is null unless specified.
updated_attimestampThe date and time the record was last updated.
view_countintegerThe total number of views associated with the workbook.
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!