---
schema_version: "1"
id: a3441c54ca6f5d6aa1f8dbbdceaa9a4b6639108ef75784a565c8e5e118be37e9
title: Entity Snapshots Reference
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/online/activity_log_entity_snapshots_reference.md
canonical_url: https://help.tableau.com/current/online/en-us/activity_log_entity_snapshots_reference.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 55dd478cd85469decbc293018f0cea8c03b2869100e1a7e3b67fec59d9777653
description: This topic describes the entity snapshot tables and fields available through the Tableau Cloud Manager REST API
---
[Skip to main content](#main-content)

# 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](https://help.tableau.com/current/online/en-us/activity_log_entity_snapshots.htm) and [Platform Data](https://help.tableau.com/current/api/cloud-manager/en-us/docs/platform_data.html).

## 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.

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>description</td><td>string</td><td>A description of what the capability allows a user to do.</td></tr><tr><td>display_name</td><td>string</td><td>The name of the capability as it appears to users.</td></tr><tr><td>display_order</td><td>integer</td><td>The order in which capabilities are listed in the interface.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>name</td><td>string</td><td>The name or ID used to refer to the capability in code.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr></tbody></table>

## data\_connections

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

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

## datasources

The `datasources` entity type contains information about published data sources.

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

## flows

The `flows` entity type contains information about published flows.

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

## group\_users

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>group_id</td><td>integer</td><td>The ID of the group.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site for the group users.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>user_id</td><td>integer</td><td>The ID of the user.</td></tr></tbody></table>

## groups

The `groups` entity type contains information about user groups.

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>created_at</td><td>timestamp</td><td>The date and time this record was created.</td></tr><tr><td>domain_id</td><td>integer</td><td>The ID of the domain associated with the group.</td></tr><tr><td>external_user_enabled</td><td>boolean</td><td>Indicates whether external users can be added to the group.</td></tr><tr><td>grant_license_mode</td><td>string</td><td>Indicates when to grant a license to group members. Either ON_SYNC or ON_LOGIN.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>last_synchronized</td><td>timestamp</td><td>The date and time the Active Directory group was last synchronized.</td></tr><tr><td>luid</td><td>uuid</td><td>An identifier that is unique when combined with the site ID.</td></tr><tr><td>minimum_site_role</td><td>string</td><td>The minimum site role assigned to members of the Active Directory group.</td></tr><tr><td>minimum_site_role_id</td><td>integer</td><td>The ID of the minimum site role for the group.</td></tr><tr><td>name</td><td>string</td><td>The name of the group.</td></tr><tr><td>owner_id</td><td>integer</td><td>The ID of the user who owns the group.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site the group belongs to.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>system</td><td>boolean</td><td>Indicates whether the group was created by Tableau or a user.</td></tr><tr><td>updated_at</td><td>timestamp</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## next\_gen\_permissions

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>authorizable_id</td><td>integer</td><td>The ID of the content for which permissions are specified.</td></tr><tr><td>authorizable_type</td><td>string</td><td>The type of content for which permissions are specified. Either Project, Workbook, DataSource, View, or NamedResource.</td></tr><tr><td>capability_id</td><td>integer</td><td>The ID of the capability being granted or denied.</td></tr><tr><td>grantee_id</td><td>integer</td><td>The ID of the user, group, or groupset being granted permissions.</td></tr><tr><td>grantee_type</td><td>string</td><td>The type of grantee. Either User, Group, or GroupAND.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>permission</td><td>integer</td><td>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.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site where the permissions belong.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr></tbody></table>

## projects

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>admin_insights_enabled</td><td>boolean</td><td>Indicates whether the project is an Admin Insights project.</td></tr><tr><td>controlled_permissions_enabled</td><td>boolean</td><td>Indicates whether permissions are controlled at the project level.</td></tr><tr><td>controlling_permissions_project_id</td><td>integer</td><td>The ID of the ancestor project that controls permissions for this project.</td></tr><tr><td>created_at</td><td>timestamp</td><td>The date and time this record was created.</td></tr><tr><td>description</td><td>string</td><td>A description of the project.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>luid</td><td>uuid</td><td>The unique identifier for the record.</td></tr><tr><td>name</td><td>string</td><td>The name of the project.</td></tr><tr><td>nested_projects_permissions_included</td><td>boolean</td><td>Indicates whether permissions for nested projects are controlled at the project level.</td></tr><tr><td>owner_id</td><td>integer</td><td>The ID of the user who owns the project.</td></tr><tr><td>parent_project_id</td><td>integer</td><td>The ID of the parent project. This is null for top-level projects.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site that contains the project.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>special</td><td>integer</td><td>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.</td></tr><tr><td>state</td><td>string</td><td>The state of the project. Either active or inactive.</td></tr><tr><td>updated_at</td><td>timestamp</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## projects\_contents

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>content_id</td><td>integer</td><td>The ID of the content stored in the project, denoted by project_id. Use with content_type to uniquely identify the content.</td></tr><tr><td>content_type</td><td>string</td><td>The type of content in the project. Use with content_id to uniquely identify the content.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>project_id</td><td>integer</td><td>The ID of the project associated with the record.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site associated with the record.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr></tbody></table>

## published\_connection\_revision\_tables

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>published_connection_table_luid</td><td>uuid</td><td>The ID of the associated published connection table.</td></tr><tr><td>revisable_properties</td><td>jsonb</td><td>Properties that users can revise.</td></tr><tr><td>revision_id</td><td>integer</td><td>The ID of the associated revision.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the associated site.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>system_properties</td><td>jsonb</td><td>System metadata.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## published\_connection\_revisions

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>luid</td><td>uuid</td><td>The unique identifier for the revision within a site.</td></tr><tr><td>owner_id</td><td>integer</td><td>The ID of the user who owns the revision.</td></tr><tr><td>published_at</td><td>timestamp without time zone</td><td>The date and time this revision was published.</td></tr><tr><td>published_connection_id</td><td>integer</td><td>The ID of the associated published connection.</td></tr><tr><td>revisable_properties</td><td>jsonb</td><td>Properties that users can revise.</td></tr><tr><td>revisable_properties_updated_at</td><td>timestamp without time zone</td><td>The date and time the revisable properties were last updated.</td></tr><tr><td>revisable_properties_version</td><td>integer</td><td>A number that increments each time revisable properties are updated.</td></tr><tr><td>revision_type</td><td>integer</td><td>The type of revision. The value 0 = draft, 1 = active, 2 = historical.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the associated site.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>system_properties</td><td>jsonb</td><td>System metadata.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr><tr><td>version_number</td><td>integer</td><td>The incrementing version number for the revision.</td></tr></tbody></table>

## published\_connection\_tables

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>description</td><td>string</td><td>The description of the published connection table.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>luid</td><td>uuid</td><td>The unique identifier for the table within a site.</td></tr><tr><td>name</td><td>string</td><td>The name of the published connection table.</td></tr><tr><td>published_connection_id</td><td>integer</td><td>The ID of the associated published connection.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the associated site.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## published\_connections

The `published_connections` entity type contains information about published connections.

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>activated</td><td>boolean</td><td>Indicates whether the published connection was made available for use.</td></tr><tr><td>created_at</td><td>timestamp</td><td>The date and time this record was created.</td></tr><tr><td>description</td><td>string</td><td>The description of the published connection.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>luid</td><td>uuid</td><td>The unique identifier for the connection within a site.</td></tr><tr><td>name</td><td>string</td><td>The name of the published connection.</td></tr><tr><td>owner_id</td><td>integer</td><td>The ID of the user who owns the connection.</td></tr><tr><td>project_id</td><td>integer</td><td>The ID of the associated project.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the associated site.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>updated_at</td><td>timestamp</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## schedules

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>actionable</td><td>boolean</td><td>Indicates whether the schedule is actionable.</td></tr><tr><td>active</td><td>boolean</td><td>Indicates whether the schedule is active. If false, no tasks run when the schedule triggers.</td></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>day_of_month_mask</td><td>integer</td><td>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.</td></tr><tr><td>day_of_week_mask</td><td>integer</td><td>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.</td></tr><tr><td>defined_by</td><td>integer</td><td>The type of mechanism that created the schedule, such as 0 for system administrator and 1 for self-service.</td></tr><tr><td>end_at_minute</td><td>integer</td><td>The minute the schedule stops triggering within its frequency period.</td></tr><tr><td>end_schedule_at</td><td>timestamp without time zone</td><td>The date and time after which the schedule no longer triggers.</td></tr><tr><td>hidden</td><td>boolean</td><td>Indicates whether the schedule is visible in the interface.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>linked_task_enabled</td><td>boolean</td><td>Indicates whether users can create linked tasks on this schedule.</td></tr><tr><td>luid</td><td>uuid</td><td>The unique identifier for the schedule used in the REST API.</td></tr><tr><td>minute_interval</td><td>integer</td><td>The interval at which the schedule retriggers after starting. Defined by schedule_type, end_at_minute, or end_schedule_at.</td></tr><tr><td>name</td><td>string</td><td>The name of the schedule.</td></tr><tr><td>priority</td><td>integer</td><td>The priority of the schedule from 1 (highest) to 100 (lowest).</td></tr><tr><td>run_next_at</td><td>timestamp without time zone</td><td>The date and time the schedule will next trigger.</td></tr><tr><td>schedule_type</td><td>integer</td><td>The frequency of the schedule. The value 0 = Hourly, 1 = Daily, 2 = Weekly, and 3 = Monthly.</td></tr><tr><td>scheduled_action</td><td>integer</td><td>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.</td></tr><tr><td>serial_collection_id</td><td>integer</td><td>The ID used to prevent simultaneous processing of linked jobs. Jobs with the same serial_collection_id can't run at the same time.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>start_at_minute</td><td>integer</td><td>The minute the schedule starts within its frequency period. For example, with a daily schedule, this is the number of minutes past midnight.</td></tr><tr><td>timezoneid</td><td>string</td><td>The IANA time zone for the schedule, such as America/Los_Angeles.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## subscriptions

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

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

## system\_users

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>admin_level</td><td>integer</td><td>Indicates whether the user is a system administrator. The value 10 = system administrator and 0 = not a system administrator.</td></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>custom_display_name</td><td>boolean</td><td>Indicates whether to prevent the friendly name from being overwritten by Active Directory.</td></tr><tr><td>domain_id</td><td>integer</td><td>The ID of the domain for the user.</td></tr><tr><td>email</td><td>string</td><td>The user's email address.</td></tr><tr><td>failed_login_attempts</td><td>integer</td><td>The number of failed login attempts since the last successful login.</td></tr><tr><td>force_password_update</td><td>boolean</td><td>Indicates whether the user must reset their password at the next login.</td></tr><tr><td>friendly_name</td><td>string</td><td>The name used in the interface to refer to the user.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>last_failed_login</td><td>timestamp without time zone</td><td>The date and time of the user's last unsuccessful login.</td></tr><tr><td>last_password_update</td><td>timestamp without time zone</td><td>The date and time the user last updated their password.</td></tr><tr><td>name</td><td>string</td><td>The user name.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## taggings

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site the tagging belongs to.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>tag_id</td><td>integer</td><td>The ID of the tag.</td></tr><tr><td>taggable_id</td><td>integer</td><td>The ID of the tagged item.</td></tr><tr><td>taggable_type</td><td>string</td><td>The type of item being tagged. This value identifies which table to join to.</td></tr><tr><td>user_id</td><td>integer</td><td>The ID of the user who owns the tag.</td></tr></tbody></table>

## tags

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

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>name</td><td>string</td><td>The name of the tag.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site the tag belongs to.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## tasks

The `tasks` entity type contains information about scheduled tasks.

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

## users

The `users` entity type contains information about site users.

<table class="simple-table" style="max-width: 100%;"><colgroup><col style="width: 25%;"> <col style="width: 15%;"> <col></colgroup><tbody><tr><th>Field Name</th><th>Type</th><th>Description</th></tr><tr><td>created_at</td><td>timestamp without time zone</td><td>The date and time this record was created.</td></tr><tr><td>id</td><td>integer</td><td>The unique identifier for the record.</td></tr><tr><td>login_at</td><td>timestamp without time zone</td><td>The date and time of the user's most recent login.</td></tr><tr><td>luid</td><td>uuid</td><td>The unique identifier for the record.</td></tr><tr><td>site_id</td><td>integer</td><td>The ID of the site the user belongs to.</td></tr><tr><td>site_luid</td><td>string</td><td>The LUID of the site.</td></tr><tr><td>site_role_id</td><td>integer</td><td>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.</td></tr><tr><td>system_admin_auto</td><td>boolean</td><td>Indicates whether the user is a system administrator not explicitly assigned to the site.</td></tr><tr><td>system_user_id</td><td>integer</td><td>The ID of the system user associated with this user.</td></tr><tr><td>updated_at</td><td>timestamp without time zone</td><td>The date and time the record was last updated.</td></tr></tbody></table>

## views

The `views` entity type contains information about views in workbooks.

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

## workbooks

The `workbooks` entity type contains information about published workbooks.

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