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 Name Type Description
description string A description of what the capability allows a user to do.
display_name string The name of the capability as it appears to users.
display_order integer The order in which capabilities are listed in the interface.
id integer The unique identifier for the record.
name string The name or ID used to refer to the capability in code.
site_luid string The LUID of the site.

data_connections

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

Field Name Type Description
authentication string The authentication method used for the data connection.
caption string The name of the connection as it appears in the Data pane.
cloud_file_request_url string The request URL for a cloud file associated with the data connection. This value can be null.
created_at timestamp The date and time this record was created.
datasource_id integer The ID of the data source that owns this data connection.
db_subclass string A subclass of the database class. For example, if the database class is web-data-direct, the subclass is intuit-quickbook.
dbclass string The type of data connection, such as MySQL, PostgreSQL, or SQL proxy.
dbname string The name of the database for this connection.
has_extract boolean Indicates whether the data connection is an extract.
id integer The unique identifier for the record.
keychain string An encoded string in YAML format.
luid uuid The unique identifier used to identify the connection in the Tableau REST API. Tableau automatically generates this value.
name string The unique name for the data connection.
owner_id integer The ID of the workbook or data source that created the data connection.
owner_type string The type of content that created the data connection. Either workbook or data source.
password boolean Indicates whether the password is embedded in the owner.
port integer The port number for the connection.
query_tagging_enabled boolean Indicates whether queries for this data connection are tagged with information about their origin in Tableau.
server string The name of the server for the connection.
site_id integer The ID of the site where the data connection is located.
site_luid string The LUID of the site.
state string The publication state. Either active or archived.
tablename string The name of the database table for the connection.
updated_at timestamp The date and time the record was last updated.
username string The user name used for the connection.
using_remote_query_agent boolean Indicates whether the data connection uses Tableau Bridge.

datasources

The datasources entity type contains information about published data sources.

Field Name Type Description
certification_note string The explanation for the certification status.
certifier_details string A snapshot of the certifier information.
certifier_user_id integer The ID of the user who certified the data source. This value is null if the data source isn't certified.
connectable boolean Indicates whether the data source supports connections through Data Server.
content_version integer The version number of the data source updated with each publication.
created_at timestamp The date and time this record was created.
data_engine_extracts boolean Indicates whether the data is provided as a Tableau data extract.
db_class string The type of data connection, such as Excel or Oracle.
db_name string The name of the database or the file path for the data source.
description string A description of the data source.
document_version string The internal version of the .tds file for this record.
extracts_incremented_at timestamp The date and time of the last incremental extract refresh.
extracts_refreshed_at timestamp The date and time of the last full extract refresh.
first_published_at timestamp The date and time the data source was first published.
hidden_name string The auto-generated name for the data source extracted from the file.
id integer The unique identifier for the record.
incrementable_extracts boolean Indicates whether incremental extracts are allowed for the published data source.
is_certified boolean Indicates whether the data source is certified.
is_hierarchical boolean If true, the source is a hierarchical (cube) database.
last_published_at timestamp The date and time the data source was last published.
luid string The unique identifier for the data source.
modified_by_user_id integer The ID of the user who last modified and published the data source. For older records, this value is the same as owner_id.
name string The name of the published data source.
owner_id integer The user ID of the owner or uploader of the data source.
parent_type string The parent type of the data source. Either datarole, workbook, or null.
parent_workbook_id integer The ID of the workbook that contains this data source. This is null for published data sources.
refreshable_extracts boolean Indicates whether refreshable extracts are available for the published data source.
remote_query_agent_id integer The ID of the agent used for remote queries.
repository_url string A unique name for the data source used in URLs.
revision string The version number of the data source, which increments each time it is published.
site_id integer The ID of the site associated with the data source.
site_luid string The LUID of the site.
size long The size of the data source in bytes.
state string The publication state. Either active or archived.
table_name string The name of the table or worksheet associated with the published data source.
updated_at timestamp The date and time the record was last updated.
using_remote_query_agent boolean Indicates whether queries to this data source use a remote agent.

flows

The flows entity type contains information about published flows.

Field Name Type Description
content_version integer The version number of the flow updated with each publication.
created_at timestamp The date and time this record was created.
data_engine_extracts boolean Indicates whether the data is provided as a Tableau data extract.
description string The description of the flow.
document_version string The internal version of the .tfl file for this record.
file_type string The file type. Either .tfl or .tflx.
hidden boolean Indicates whether the flow is hidden from the content management system.
id integer The unique identifier for the flow.
is_deleted boolean Indicates whether the flow is in the Recycle Bin. Deleted flows aren't visible to active jobs or user requests until restored.
kind string The type of flow.
last_published_at timestamp The date and time the flow was last published.
luid uuid The unique identifier for the flow.
name string The name of the published flow.
owner_id integer The user ID of the owner or publisher of the flow.
project_id integer The ID of the project associated with the flow.
site_id integer The ID of the site associated with the flow.
site_luid string The LUID of the site.
size long The size of the flow file in bytes.
state string The state of the flow. Either active or archived. The default is active.
updated_at timestamp The date and time the record was last updated.

group_users

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

Field Name Type Description
group_id integer The ID of the group.
id integer The unique identifier for the record.
site_id integer The ID of the site for the group users.
site_luid string The LUID of the site.
user_id integer The ID of the user.

groups

The groups entity type contains information about user groups.

Field Name Type Description
created_at timestamp The date and time this record was created.
domain_id integer The ID of the domain associated with the group.
external_user_enabled boolean Indicates whether external users can be added to the group.
grant_license_mode string Indicates when to grant a license to group members. Either ON_SYNC or ON_LOGIN.
id integer The unique identifier for the record.
last_synchronized timestamp The date and time the Active Directory group was last synchronized.
luid uuid An identifier that is unique when combined with the site ID.
minimum_site_role string The minimum site role assigned to members of the Active Directory group.
minimum_site_role_id integer The ID of the minimum site role for the group.
name string The name of the group.
owner_id integer The ID of the user who owns the group.
site_id integer The ID of the site the group belongs to.
site_luid string The LUID of the site.
system boolean Indicates whether the group was created by Tableau or a user.
updated_at timestamp The 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 Name Type Description
authorizable_id integer The ID of the content for which permissions are specified.
authorizable_type string The type of content for which permissions are specified. Either Project, Workbook, DataSource, View, or NamedResource.
capability_id integer The ID of the capability being granted or denied.
grantee_id integer The ID of the user, group, or groupset being granted permissions.
grantee_type string The type of grantee. Either User, Group, or GroupAND.
id integer The unique identifier for the record.
permission integer The 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_id integer The ID of the site where the permissions belong.
site_luid string The LUID of the site.

projects

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

Field Name Type Description
admin_insights_enabled boolean Indicates whether the project is an Admin Insights project.
controlled_permissions_enabled boolean Indicates whether permissions are controlled at the project level.
controlling_permissions_project_id integer The ID of the ancestor project that controls permissions for this project.
created_at timestamp The date and time this record was created.
description string A description of the project.
id integer The unique identifier for the record.
luid uuid The unique identifier for the record.
name string The name of the project.
nested_projects_permissions_included boolean Indicates whether permissions for nested projects are controlled at the project level.
owner_id integer The ID of the user who owns the project.
parent_project_id integer The ID of the parent project. This is null for top-level projects.
site_id integer The ID of the site that contains the project.
site_luid string The LUID of the site.
special integer Indicates 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.
state string The state of the project. Either active or inactive.
updated_at timestamp The date and time the record was last updated.

projects_contents

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

Field Name Type Description
content_id integer The ID of the content stored in the project, denoted by project_id. Use with content_type to uniquely identify the content.
content_type string The type of content in the project. Use with content_id to uniquely identify the content.
id integer The unique identifier for the record.
project_id integer The ID of the project associated with the record.
site_id integer The ID of the site associated with the record.
site_luid string The 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 Name Type Description
created_at timestamp without time zone The date and time this record was created.
id integer The unique identifier for the record.
published_connection_table_luid uuid The ID of the associated published connection table.
revisable_properties jsonb Properties that users can revise.
revision_id integer The ID of the associated revision.
site_id integer The ID of the associated site.
site_luid string The LUID of the site.
system_properties jsonb System metadata.
updated_at timestamp without time zone The 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 Name Type Description
created_at timestamp without time zone The date and time this record was created.
id integer The unique identifier for the record.
luid uuid The unique identifier for the revision within a site.
owner_id integer The ID of the user who owns the revision.
published_at timestamp without time zone The date and time this revision was published.
published_connection_id integer The ID of the associated published connection.
revisable_properties jsonb Properties that users can revise.
revisable_properties_updated_at timestamp without time zone The date and time the revisable properties were last updated.
revisable_properties_version integer A number that increments each time revisable properties are updated.
revision_type integer The type of revision. The value 0 = draft, 1 = active, 2 = historical.
site_id integer The ID of the associated site.
site_luid string The LUID of the site.
system_properties jsonb System metadata.
updated_at timestamp without time zone The date and time the record was last updated.
version_number integer The incrementing version number for the revision.

published_connection_tables

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

Field Name Type Description
created_at timestamp without time zone The date and time this record was created.
description string The description of the published connection table.
id integer The unique identifier for the record.
luid uuid The unique identifier for the table within a site.
name string The name of the published connection table.
published_connection_id integer The ID of the associated published connection.
site_id integer The ID of the associated site.
site_luid string The LUID of the site.
updated_at timestamp without time zone The date and time the record was last updated.

published_connections

The published_connections entity type contains information about published connections.

Field Name Type Description
activated boolean Indicates whether the published connection was made available for use.
created_at timestamp The date and time this record was created.
description string The description of the published connection.
id integer The unique identifier for the record.
luid uuid The unique identifier for the connection within a site.
name string The name of the published connection.
owner_id integer The ID of the user who owns the connection.
project_id integer The ID of the associated project.
site_id integer The ID of the associated site.
site_luid string The LUID of the site.
updated_at timestamp The date and time the record was last updated.

schedules

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

Field Name Type Description
actionable boolean Indicates whether the schedule is actionable.
active boolean Indicates whether the schedule is active. If false, no tasks run when the schedule triggers.
created_at timestamp without time zone The date and time this record was created.
day_of_month_mask integer An encoded value that indicates the days of the month 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_mask integer An encoded value that indicates the days of the week 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, 1000 = Wednesday, 10000 = Thursday, 100000 = Friday, 1000000 = Saturday.
defined_by integer The type of mechanism that created the schedule, such as 0 for system administrator and 1 for self-service.
end_at_minute integer The minute the schedule stops triggering within its frequency period.
end_schedule_at timestamp without time zone The date and time after which the schedule no longer triggers.
hidden boolean Indicates whether the schedule is visible in the interface.
id integer The unique identifier for the record.
linked_task_enabled boolean Indicates whether users can create linked tasks on this schedule.
luid uuid The unique identifier for the schedule used in the REST API.
minute_interval integer The interval at which the schedule retriggers after starting. Defined by schedule_type, end_at_minute, or end_schedule_at.
name string The name of the schedule.
priority integer The priority of the schedule from 1 (highest) to 100 (lowest).
run_next_at timestamp without time zone The date and time the schedule will next trigger.
schedule_type integer The frequency of the schedule. The value 0 = Hourly, 1 = Daily, 2 = Weekly, and 3 = Monthly.
scheduled_action integer The type of task assigned to the schedule. The value 0 = Extracts, 1 = Subscriptions, 2 = Active Directory synchronization, 3 = Auto Refresh Extracts, and 4 = Flows.
serial_collection_id integer The ID used to prevent simultaneous processing of linked jobs. Jobs with the same serial_collection_id can't run at the same time.
site_luid string The LUID of the site.
start_at_minute integer The minute the schedule starts within its frequency period. For example, with a daily schedule, this is the number of minutes past midnight.
timezoneid string The IANA time zone for the schedule, such as America/Los_Angeles.
updated_at timestamp without time zone The date and time the record was last updated.

subscriptions

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

Field Name Type Description
attach_image boolean Indicates whether to attach images to the subscription email.
attach_pdf boolean Indicates whether to attach a PDF to the subscription email.
content_has_user_references boolean Indicates whether the subscription content includes user references. Null means the subscription hasn't run yet.
created_at timestamp without time zone The date and time this record was created.
creator_id integer The ID of the user who created the subscription.
data_condition_type string The type of data condition that triggers the subscription. The default is Always. Other values include DataPresent, Constant, Band, and more.
id integer The unique identifier for the record.
is_refresh_extract_triggered boolean Indicates whether the subscription is triggered by an extract refresh.
last_sent timestamp without time zone The date and time the subscription was last sent.
luid uuid The unique identifier for the subscription used in the REST API.
schedule_id integer The ID of the schedule that triggers the subscription.
site_id integer The ID of the site where the subscription is located.
site_luid string The LUID of the site.
subject string The subject line or description of the subscription.
subscription_message_id integer The ID for the subscription message.
target_id integer The ID of the content being subscribed to.
target_type string The type of content being subscribed to. Either View or Workbook.
user_id integer The ID of the user who receives the subscription.

system_users

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

Field Name Type Description
admin_level integer Indicates whether the user is a system administrator. The value 10 = system administrator and 0 = not a system administrator.
created_at timestamp without time zone The date and time this record was created.
custom_display_name boolean Indicates whether to prevent the friendly name from being overwritten by Active Directory.
domain_id integer The ID of the domain for the user.
email string The user's email address.
failed_login_attempts integer The number of failed login attempts since the last successful login.
force_password_update boolean Indicates whether the user must reset their password at the next login.
friendly_name string The name used in the interface to refer to the user.
id integer The unique identifier for the record.
last_failed_login timestamp without time zone The date and time of the user's last unsuccessful login.
last_password_update timestamp without time zone The date and time the user last updated their password.
name string The user name.
site_luid string The LUID of the site.
updated_at timestamp without time zone The date and time the record was last updated.

taggings

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

Field Name Type Description
id integer The unique identifier for the record.
site_id integer The ID of the site the tagging belongs to.
site_luid string The LUID of the site.
tag_id integer The ID of the tag.
taggable_id integer The ID of the tagged item.
taggable_type string The type of item being tagged. This value identifies which table to join to.
user_id integer The ID of the user who owns the tag.

tags

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

Field Name Type Description
created_at timestamp without time zone The date and time this record was created.
id integer The unique identifier for the record.
name string The name of the tag.
site_id integer The ID of the site the tag belongs to.
site_luid string The LUID of the site.
updated_at timestamp without time zone The date and time the record was last updated.

tasks

The tasks entity type contains information about scheduled tasks.

Field Name Type Description
active boolean Indicates whether the task is active. If false, the task doesn't run when the schedule triggers.
args string Task parameters formatted as YAML.
consecutive_failure_count integer The number of times this task has failed.
created_at timestamp without time zone The date and time this record was created.
creator_id integer The ID of the user who created the task.
historical_queue_time integer The historical queue time of the task in seconds.
historical_run_time integer The historical run time of the task in seconds.
id integer The unique identifier for the table.
last_success_completed_at timestamp without time zone The date and time the task last completed successfully.
luid uuid The unique identifier for the task used in the REST API.
obj_id integer The ID of the workbook or data source associated with the task.
obj_type string The type of object associated with the task. Either Workbook or Data Source. Use with obj_id to uniquely identify the object.
priority integer The priority of the task where 0 is the highest priority and 10 is the default.
run_count integer The 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_id integer The ID of the schedule linked to the task. When the schedule's run_next_at time arrives, linked tasks run.
site_id integer The ID of the site associated with the task. Used for site-specific tasks.
site_luid string The LUID of the site.
state integer The current state of the task. The value 0 = active, 1 = suspended, and 2 = disabled.
subtitle string Additional information about the task.
title string Additional information about the task.
type string The type of task.
updated_at timestamp without time zone The date and time the record was last updated.

users

The users entity type contains information about site users.

Field Name Type Description
created_at timestamp without time zone The date and time this record was created.
id integer The unique identifier for the record.
login_at timestamp without time zone The date and time of the user's most recent login.
luid uuid The unique identifier for the record.
site_id integer The ID of the site the user belongs to.
site_luid string The LUID of the site.
site_role_id integer The 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_auto boolean Indicates whether the user is a system administrator not explicitly assigned to the site.
system_user_id integer The ID of the system user associated with this user.
updated_at timestamp without time zone The date and time the record was last updated.

views

The views entity type contains information about views in workbooks.

Field Name Type Description
caption string The description of the worksheet based on the workbook definition.
created_at timestamp without time zone The date and time this record was created.
description string The description of the view.
fields string The fields extracted from the workbook's .twb file.
first_published_at timestamp without time zone The date and time the view was first published. This value doesn't change if the workbook containing the view is republished.
id integer The unique identifier for the record.
index integer The index number of the view within its workbook.
is_deleted boolean Indicates whether the view is in the Recycle Bin.
luid uuid The unique identifier for the record.
name string The name of the view.
owner_id integer The ID of the user who owns the view.
repository_url string A unique name for the view used in URLs.
revision string The version number of the view. The value starts at 1.0 and increments by 0.1 with each republication
sheet_id string The identifier for the sheet.
sheettype string The type of sheet. Either story, dashboard, or view.
site_id integer The ID of the site the view belongs to.
site_luid string The LUID of the site.
state string The state of the view. Either active or disabled.
title string The title of the worksheet extracted from the workbook's .twb file.
updated_at timestamp without time zone The date and time the record was last updated.
workbook_id integer The ID of the workbook that contains the view.

workbooks

The workbooks entity type contains information about published workbooks.

Field Name Type Description
content_version integer The version number of the workbook updated with each publication.
created_at timestamp The date and time this record was created.
data_engine_extracts boolean Indicates whether the workbook has associated data engine extracts.
default_view_index integer Indicates which view is shown by default.
display_tabs boolean If true, sheets appear as tabs in the workbook.
document_version string The version of the document description used when the workbook was saved.
first_published_at timestamp The date and time the workbook was first published. This value doesn't change when the workbook is republished.
id integer The unique identifier for the record.
incrementable_extracts boolean Indicates whether incremental extract refreshes are possible for this workbook.
is_deleted boolean Indicates whether the workbook is in the Recycle Bin. Deleted workbooks aren't visible to active jobs or user requests until restored.
last_published_at timestamp The date and time the workbook was last published.
luid uuid The unique identifier for the record.
modified_by_user_id integer The ID of the user who last modified and published the workbook. For older records, this value is the same as owner_id.
name string The name of the workbook.
owner_id integer The ID of the user who owns this workbook.
published_all_sheets boolean Indicates whether all sheets in the workbook were published.
refreshable_extracts boolean Indicates whether extracts in the workbook can be refreshed.
repository_url string A unique name for the workbook used in URLs.
revision string The version number of the workbook. The value starts at 1.0 and increments by 0.1 with each republication
site_id integer The ID of the site where the workbook was published.
site_luid string The LUID of the site.
size bigint The size of the workbook in bytes.
thumb_user integer The ID of the user used to generate the thumbnail image. This value is null unless specified.
updated_at timestamp The date and time the record was last updated.
view_count integer The total number of views associated with the workbook.
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!