# Tableau integration

> Tableau REST API, Metadata API (GraphQL) and VizQL Data Service for managing and querying content on Tableau Server and Tableau Cloud.

- Authentication: apiKey

## Tools (489)

- **Add analytics extension connection to site**: Adds a new analytics extension connection for an external service to a site.
- **Add Collection Permissions**: Adds permissions to the specified collection for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it.
- **Add Database Permissions**: Add permissions to a database asset. To add permissions, the database asset must be associated with a published data source.
- **Add Data Quality Warning**: Add a data quality warning to a database, table, column, published data source, flow, virtual connection, or virtual connection table. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods.
- **Add Data Source Permissions**: Adds permissions to the specified data source for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it.
- **Add Data Source to Favorites**: Adds the specified data source to the user's favorites. If the user already has the data source listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten.
- **Add Data Source to Server Schedule**: Adds a task to refresh a data source to an existing server schedule on Tableau Server. For Tableau Cloud, see Create Cloud Extract Refresh Task.
- **Add Default Database Permissions**: Adds default permission capabilities to a user or group for table resources in that database. Default permissions function as a permissions template for the database's table assets. Note: If a database is in a project, default database permissions are not evaluated to determine table permissions.
- **Add Default Permissions**: Adds default permission rules for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, also adds default permission rules for database or table resources in a project for a user or group.
- **Add Domain to Pool**: Associates a domain with a specific Bridge pool, allowing Bridge clients from that domain to use the pool. Each domain can only be assigned to one pool at a time. Root domains and subdomains are supported. Domain assignments are site-specific. Adding a domain already in the pool returns an error.
- **Add Flow Permissions**: Adds permissions to the specified flow for a Tableau Server user or group. You can specify multiple sets of permissions using one call.
- **Add Flow Task to Server Schedule**: Adds a task to run a flow to an existing schedule. Note: This method is unavailable if you do not have a Data Management license or Tableau Prep Conductor is disabled for your site.
- **Add Flow to Favorites**: Adds the specified flow to the user's favorites. If the user already has the flow listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten.
- **Add Group to Group Set**: Adds group to a group set.
- **Add items to a collection**: Adds items to a collection.
- **Add or Update Monitoring Quality Warning on Content**: Create or update one or more monitoring quality warnings. You can monitor for extract refresh failures on extract data sources or flow run failures on flows. An asset can only have one instance of monitoring.
- **Add Project Permissions**: Adds permissions to the specified project for a user or group. You can specify multiple sets of permissions using one call. If the request body includes a child datasource or <project> element, the request is invalid.
- **Add Projects to Routing Rule**: Adds one or more project filtering conditions to an existing allow rule, narrowing the rule so it applies only to the listed projects. This method applies to allow rules only; adding projects to a block rule is rejected.
- **Add Project to Favorites**: Adds the specified project to a user's favorites. If the user already has the project listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten.
- **Add Table Permissions**: Add permissions to a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Add Tags to Column**: Add one or more tags to a column. For more information about tags, see Tag Items in the Tableau User Help.
- **Add Tags to Database**: Add one or more tags to a database. For more information about tags, see Tag Items in the Tableau User Help.
- **Add Tags to Data Source**: Adds one or more tags to the specified data source.
- **Add Tags to Table**: Add one or more tags to a table. For more information about tags, see Tag Items in the Tableau User Help.
- **Add Tags to View**: Adds one or more tags to the specified view.
- **Add Tags to Virtual Connection**: Adds tags to a virtual connection.
- **Add Tags to Workbook**: Adds one or more tags to the specified workbook.
- **Add User to Data-Driven Alert**: Adds a specified user to the recipients list for a data-driven alert.
- **Add User to Group**: Adds a user to the specified group. Beginning in API 3.21, you can bulk add users to a group by specifying multiple user IDs.
- **Add User to Identity Pool**: Add a user to a specified identity pool. This enables the user to sign in to Tableau Server using the specified identity pool. This method is not available for Tableau Cloud. For more information about identity pools, see Provision and Authenticate Users Using Identity Pools.
- **Add User to Site**: Adds a user to Tableau Server or Tableau and assigns the user to the specified site. Tableau Server If Tableau Server is configured to use local authentication, the information you specify is used to create a new user in Tableau Server.
- **Add View Permissions**: Adds permissions to the specified view (also known as a sheet) for a user or group. You can specify multiple sets of permissions using one call.
- **Add View to Favorites**: Adds the specified view to a user's favorites. If the user already has the view listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten.
- **Add Virtual Connection Permissions**: Adds permissions to the specified virtual connection for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it.
- **Add Workbook Permissions**: Adds permissions to the specified workbook for a user or group. You can specify multiple sets of permissions using one call.
- **Add Workbook to Favorites**: Adds the specified workbook to a user's favorites. If the user already has the workbook listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten.
- **Add Workbook to Server Schedule**: Adds a task to refresh or accelerate a workbook to an existing schedule on Tableau Server. The task type must match the schedule type. For a list of schedule types, see Create a Schedule. For Tableau Cloud, see Create Cloud Extract Refresh Task. Note: This method is not available for Tableau Cloud.
- **Add Work Copy Elements**: Adds field descriptions or table descriptions to a work copy. Returns HTTP 201 when every element is added. The success body omits the elements that succeeded. If any element fails, the HTTP status is the status of the first failure and the body lists only the failed elements.
- **Append to File Upload**: Uploads a block of data and appends it to the data that is already uploaded. Call this method after an upload has been initiated using Initiate File Upload, as many times as needed to upload all the blocks and complete the file.
- **Batch Add or Update Data Quality Certifications**: Create or update one or more data quality certifications for different content and asset items. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods.
- **Batch Add or Update Data Quality Warnings**: Add or update multiple data quality warnings on assets. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Batch Add Tags**: Add multiple tags to items that are different content and asset types. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. For more information about tags, see Tag Items in the Tableau User Help.
- **Batch create Pulse subscriptions**: Creates multiple subscriptions to a metric for specified users and/or groups.
- **Batch Delete Data Quality Warnings**: Delete multiple data quality warnings from assets. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Batch Delete Tags**: Delete multiple tags from items that are different content and asset types. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. For more information about tags, see Tag Items in the Tableau User Help.
- **Batch get Pulse subscriber counts**: Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs.
- **Batch get Pulse subscriptions**: Gets a batch of subscriptions, specified in a comma delimited list of subscriptions LUIDs.
- **Batch list metric definitions (few)**: Gets the details of a batch of metric definitions and metrics on a site, specified in a brief comma delimited list of LUIDs.
- **Batch list metric definitions (many)**: Gets the details of a batch of definitions specified in a comma delimited list of LUIDs. This method is optimized for batches with large numbers of definitions.
- **Batch list metrics (few)**: Gets a batch of metrics from a definition, specified in a comma delimited list.
- **Batch list metrics (many)**: Gets batches of metrics available on a server. Only metrics a user has privileges to view will be visible. This endpoint uses POST as an alternative to GET, where long lists of URL parameters could be problematic.
- **Batch update collections**: Batch updates collections.
- **Batch Update Schedule State**: Updates the state of one or more schedules. Use the updateAll URI parameter to update the state of all schedules in a single call.
- **Block Domain**: Blocks a domain from being used with any Bridge pool, preventing Bridge clients from that domain from connecting. Blocking is site-specific and takes precedence over pool assignments; blocked domains cannot be added to any pool. Existing connections from the domain may be terminated.
- **Cancel Flow Run**: Cancels a flow run that is in progress.
- **Cancel Job**: Cancels a job specified by job ID. To get a list of job IDs for jobs that are currently queued or in-progress, use the Query Jobs method.
- **Configure Identity Store**: Configure a new local identity store to provision users. For more information, see Step 2: Set up an identity store in the Tableau Server Help. Note: This identity store is in addition to the identity store you configured during Tableau Server setup.
- **Create a collection**: Creates a new collection.
- **Create an Extract for a Data Source**: Create an extract for a data source in a site. Optionally, encrypt the extract if the site and workbooks using it are configured to allow it.
- **Create a semantic context**: Create a semantic context node carrying one or more statements.
- **Create Authentication Configuration**: Create an instance of OpenID Connect (OIDC) authentication. For more information, see Step 3: Set up authentication in the Tableau Server Help.
- **Create a Webhook**: Creates a new webhook for a site.
- **Create Bridge Pool**: Creates a new Bridge pool with the specified name. The pool is created empty (no domain assignments or Bridge clients). The system assigns a UUID; use List Bridge Pools to get the pool ID after creation, then add domains and assign clients. This method is not available for Tableau Server.
- **Create Cloud Extract Refresh Task**: Creates a custom schedule for an extract refresh on Tableau Cloud, targeting a data source, workbook, or virtual connection. For Tableau Server, see Add data source to server schedule and Add workbook to server schedule.
- **Create Cloud Flow Task**: Creates a flow task on Tableau Cloud, and set its schedule. Note: This method is unavailable if you do not have a Data Management license or Tableau Prep Conductor is disabled for your site.
- **Create Connected App**: Create a connected app. A connected app can be used to securely authenticate your users to Tableau content embedded in a custom application or for REST API authorization (introduced to Tableau Cloud in June 2022 and Tableau Server 2023).
- **Create Connected App Secret**: Generate a secret for a connected app. Secrets are tokens shared by Tableau and a custom application, and used to establish a trusted relationship. A maximum of two secrets can be associated with a connected app. These secrets do not expire and remain valid until deleted.
- **Create custom domain settings**: Starts the process of custom domain setup for a Tableau site. For more information, see Setup Steps to Enable a Custom Domain.
- **Create Data Driven Alert**: Create a data driven alert (DDA) for a view with a single data axis.
- **Create Extracts for Embedded Data Sources in a Workbook**: Create extracts for all embedded data sources of a workbook. Optionally, encrypt the extracts if the site and workbook using them are configured to allow it.
- **Create Group**: Creates a group on a Tableau Cloud site or Tableau Server. Notes: To add users to a group, call Add User To Group. To make changes to an existing group, call Update Group.
- **Create Group Set**: Creates a group set with a specified name. Note: You can't use this method to populate the group set with groups. After you create a group set and its ID is available, you can add a group to the group set by calling Add Group to Group Set.
- **Create Identity Pool**: Create an identity pool. For more information, see Step 4: Create an identity pool in the Tableau Server Help.
- **Create Label Category**: Creates a data label category. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs.
- **Create metric**: Creates a metric.
- **Create metric definition**: Creates a metric definition.
- **Create metric tag for user**: Creates a tag for the specified metric, for the signed in user.
- **Create OpenID Connect Configuration**: Create the Tableau Cloud site's OpenID Connect (OIDC) configuration. After you've configured OIDC authentication, you can use the Tableau Cloud's UI to test the configuration and add users. For more information about OIDC authentication in Tableau Cloud, see OpenID Connect in the Tableau Cloud Help.
- **Create or Update labelValue**: Creates a label value with the specified name if it doesn't exist, or updates the existing label value if the label value name already exists. Note: You can update an existing label value using either this method or the Update labelValue method.
- **Create Project**: Creates a project on the specified site. You can also create project hierarchies by creating a project under the specified parent project on the site. To make changes to an existing project, call Update Project.
- **Create Routing Rule**: Creates a Bridge routing rule for a site. A routing rule controls how Bridge queries for a domain are routed.
- **Create SCIM Configuration**: Creates the System for Cross-domain Identity Management Configuration (SCIM) configuration on the Tableau Cloud site. The SCIM capability requires that you configure authentication for your Tableau Cloud site and associate the SCIM configuration with the authentication configuration.
- **Create SCIM Token**: Generates the System for Cross-domain Identity Management (SCIM) token and secret. You must be the user who created the SCIM configuration to generate the associated SCIM token.
- **Create Server Schedule**: Creates a new server schedule on Tableau Server. For Tableau Cloud, see Create Cloud Extract Refresh Task and Create subscription. Schedules are not specific to sites.
- **Create Site**: Creates a site on Tableau Server. To make changes to an existing site, call Update Site. This method isn’t available for Tableau Cloud. For more information, see Work with Sites and Add or Edit Sites in the Tableau Server documentation.
- **Create Subscription**: Creates a new subscription to a view or workbook for a specific user on Tableau Server and Tableau Cloud. When a user is subscribed to the content, Tableau sends the content to the user in email on the schedule that you define.
- **Create subscription (Pulse)**: Creates a subscription to a specified metric for a specified user or group.
- **Create Tableau MCP Settings for Site**: Replaces the current list of Tableau MCP settings for a given site. For more information about configuring the Tableau MCP settings for a site, see Site settings for Tableau MCP.
- **Create Work Copy**: Creates a work copy of a published data source and returns the work copy LUID. Composable data sources and Semantic Data Model (SDM) data sources are not supported. The call is rejected when the caller already has the maximum number of open work copies.
- **Decrypt Extracts in a Site**: Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see Extract Encryption at Rest. Decrypts all extracts on a site.
- **Delete All Recycle Bin Contents**: Permanently deletes all content in a site's Recycle Bin . Administrators delete all content in the site's Recycle Bin. Other users only delete content they own. For information about how content properties change when it's deleted or restored. See Recycle Bin.
- **Delete analytics extension connection from site**: Deletes a specific analytics extension connection for an external service from a site.
- **Delete a semantic context**: Delete a semantic context created and managed in Tableau Knowledge, along with its statements.
- **Delete Authentication Configuration**: Delete an authentication instance.
- **Delete a Webhook**: Deletes the specified webhook.
- **Delete Bridge Client**: Permanently removes a Bridge client from the site. This operation is irreversible; the Bridge client cannot be recovered through the API. Pool assignments are revoked and the client must be re-registered to reconnect.
- **Delete Bridge Pool**: Permanently deletes a Bridge pool and all its associated domain mappings. The pool must have no Bridge clients assigned (move clients first). Cannot delete reserved system pools. The operation is irreversible; domain mappings are removed and the pool ID becomes invalid.
- **Delete Collection Permission (Group)**: Removes the specified collection permission for the specified group or user.
- **Delete Collection Permission (User)**: Removes the specified collection permission for the specified group or user.
- **Delete collections**: Deletes collections.
- **Delete collections (Collections)**: Deletes collections.
- **Delete Connected App**: Permanently remove a connected app. Deleting the connected app also deletes the secrets associated with the connected app.
- **Delete Connected App Secret**: Permanently remove a secret associated with a connected app.
- **Delete custom domain settings**: Deletes the custom domain setup for a Tableau site.
- **Delete Custom View**: Deletes the specified custom view.
- **Delete Database Permissions (Group)**: Permanently remove the permissions applied to a database asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Delete Database Permissions (User)**: Permanently remove the permissions applied to a database asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Delete Data-Driven Alert**: Deletes the specified data-driven alert from the specified site.
- **Delete Data Quality Certification by ID**: Delete a data quality certification from an asset using the data quality certification ID. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods.
- **Delete Data Quality Certifications by Content**: Delete multiple data quality certifications from assets. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Delete Data Quality Warning by Content**: Delete the data quality warnings from an asset. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Delete Data Quality Warning by ID**: Delete a data quality warning from an asset using the data quality warning ID. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Delete Data Source**: Deletes the specified data source from a site. When a data source is deleted, its associated data connection is also deleted. Workbooks that use the data source are not deleted, but they will no longer work properly.
- **Delete Data Source from Favorites**: Deletes the specified data source from the user's favorites. If the specified data source is not a favorite, the operation has no effect.
- **Delete Data Source Permission (Group)**: Removes the specified data source permission for the specified group or user.
- **Delete Data Source Permission (User)**: Removes the specified data source permission for the specified group or user.
- **Delete Default Database Permissions (Group)**: Permanently remove the default permissions on a database asset. Removing the default permissions from the database asset means that any new child table assets that are indexed by Catalog won't have any default permissions set.
- **Delete Default Database Permissions (User)**: Permanently remove the default permissions on a database asset. Removing the default permissions from the database asset means that any new child table assets that are indexed by Catalog won't have any default permissions set.
- **Delete Default Permission**: Removes default permission rules for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, also removes default permission rules for database or table resources in a project for a user or group.
- **Delete Domain**: Removes a domain mapping from the system. The domain is no longer associated with any pool and can be re-added later if needed. For blocked domains, deletion unblocks the domain.
- **Delete EAS**: Delete a registered external authorization server (EAS).
- **Delete Extract Refresh Task**: Deletes the specified extract refresh task on Tableau Server or Tableau Cloud.
- **Delete Extracts of Embedded Data Sources from a Workbook**: Delete all extracts of embedded data sources in a workbook. Note: Depending on the number and size of extracts, this operation may consume significant server resources. Consider running this command outside of normal business hours.
- **Delete Flow**: Deletes a flow. When a flow is deleted, its associated connections, the output and input steps, any associated scheduled tasks, and run history are also deleted.
- **Delete Flow from Favorites**: Deletes the specified flow from the user's favorites. If the specified flow is not a favorite, the operation has no effect.
- **Delete Flow Permission (Group)**: Deletes the specified permission from the specified flow for a group or user.
- **Delete Flow Permission (User)**: Deletes the specified permission from the specified flow for a group or user.
- **Delete Group**: Deletes the group on a specific site. Deleting a group does not delete the users in group, but users are no longer members of the group. Any permissions that were previously assigned to the group no longer apply. Note: You cannot delete the All Users group.
- **Delete Group Set**: Deletes the group set on a specific site. Deleting a group set doesn’t delete the users in the group set, but users are no longer members of the group set. Any permissions that were previously assigned to the group set no longer apply.
- **Delete Identity Pool**: Delete an identity pool. Important: In Tableau Server, move users to another identity pool before deleting an identity pool. Users will no longer be able to sign in to Tableau Server unless they are a member of an identity pool.
- **Delete Identity Store**: Delete an identity store. Important: You cannot delete the identity store you configured during Tableau Server setup.
- **Delete Label**: Deletes a data label by its LUID. You can't delete extract refresh or flow run monitoring warnings (the extract_refresh_failure and flow_run_failure label values) using this method because those warnings are set and cleared automatically, depending on their triggers.
- **Delete Label Category**: Deletes a label category. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs.
- **Delete Labels**: Deletes the data labels on one or more assets. You can optionally limit the data labels to delete by category using a query string.
- **Delete labelValue**: Deletes a label value. If you use this method on a built-in label value that was customized, this method reverts the label to its built-in defaults instead of deleting it.
- **Delete metric**: Deletes a metric.
- **Delete metric definition**: Deletes a metric definition.
- **Delete metric tag**: Deletes the specified metric tag. Version: Available in API 3.25 (Tableau Cloud March 2025) and later. Not available for Tableau Server. Version Overview
- **Delete Project**: Deletes the specified project on a specific site. When a project is deleted, all Tableau assets inside of it are also deleted, including assets like associated workbooks, data sources, project view options, and rights. External assets, such as databases and tables, are not deleted.
- **Delete Project from Favorites**: Deletes the specified project from the user's favorites. If the specified project is not a favorite, the operation has no effect.
- **Delete Project Permission (Group)**: Removes the specified project permission for the specified group or user.
- **Delete Project Permission (User)**: Removes the specified project permission for the specified group or user.
- **Delete Pulse subscription**: Deletes a specified subscription to a metric.
- **Delete Quality Warning Trigger by ID**: Permanently remove a quality warning trigger using the quality warning trigger ID. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Delete Quality Warning Triggers by Content**: Permanently remove all quality warning triggers for one or more data sources or flows, or both. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Delete Recycle Bin Content Item**: Permanently deletes the specified Recycle Bin content item. Administrators can delete any content in the site's Recycle Bin. Other users can only delete content they own. For information about how content properties change when it's deleted or restored. See Recycle Bin.
- **Delete Routing Rule**: Permanently deletes a Bridge routing rule identified by its ID. This method applies to both allow rules and block rules. Deletion is immediate; the domain is no longer routed (or blocked) by the removed rule. If no rule matches the ID, a 404 error is returned.
- **Delete SCIM Configuration**: Permanently removes the System for Cross-domain Identity Management (SCIM) configuration from the Tableau Cloud site. Deleting the SCIM configuration deletes the associated SCIM token.
- **Delete SCIM Token**: Permanently removes the System for Cross-domain Identity Management (SCIM) token. You must be the user that created the SCIM configuration to delete the associated SCIM token unless the creator of the SCIM configuration is no longer a member of the site.
- **Delete Server Schedule**: Deletes the specified schedule on Tableau Server. For Tableau Cloud, see Delete Extract Refresh Task and Delete Subscription.
- **Delete Server Session**: Deletes a specified session. This method is not available for Tableau Cloud and is typically used in programmatic management of the life cycles of embedded Tableau sessions.
- **Delete Site**: Deletes the specified site. You can specify the site to delete by using the site ID, the site name, or the content URL. You use the key query string parameter to indicate how you are specifying the site, as shown in the URIs.
- **Delete Site Asynchronously**: Deletes the specified site. You can specify the site to delete by using the site ID, the site name, or the content URL. You use the key query string parameter to indicate how you are specifying the site, as shown in the URIs.
- **Delete Subscription**: Deletes the specified subscription on Tableau Server or Tableau Cloud.
- **Delete Table Permissions (Group)**: Permanently remove the permissions applied to a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Delete Table Permissions (User)**: Permanently remove the permissions applied to a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Delete Tag from Column**: Delete a tag from a column. For more information about tags, see Tag Items in the Tableau User Help.
- **Delete Tag from Database**: Delete a tag from a database. For more information about tags, see Tag Items in the Tableau User Help.
- **Delete Tag from Data Source**: Deletes a tag from the specified data source.
- **Delete Tag from Table**: Delete a tag from a table. For more information about tags, see Tag Items in the Tableau User Help.
- **Delete Tag from View**: Deletes a tag from the specified view.
- **Delete Tag from Virtual Connection**: Deletes a tag from a virtual connection.
- **Delete Tag from Workbook**: Deletes a tag from the specified workbook.
- **Delete the Extract from a Data Source**: Delete the extract of a data source in a site.
- **Delete User from Data-Driven Alert**: Removes a specified user from the recipients list for a data-driven alert.
- **Delete Users from Site with CSV**: Creates a job to remove a list of users, specified in a .csv file, from a site.
- **Delete View**: Deletes a view from a workbook. Use the Get Workbook method or the Query Views for Workbook method to find the view ID. If you delete the only view in a workbook, the workbook is deleted.
- **Delete View from Favorites**: Deletes the specified view from user's favorites. If the specified view is not a favorite, the operation has no effect.
- **Delete View Permission (Group)**: Deletes permission to the specified view (also known as a sheet) for a Tableau Server user or group.
- **Delete View Permission (User)**: Deletes permission to the specified view (also known as a sheet) for a Tableau Server user or group.
- **Delete Virtual Connection**: Deletes a virtual connection.
- **Delete Virtual Connection Permission (Group)**: Removes the specified virtual connection permission for the specified group or user.
- **Delete Virtual Connection Permission (User)**: Removes the specified virtual connection permission for the specified group or user.
- **Delete Workbook**: Deletes a workbook. When a workbook is deleted, all of its assets are also deleted, including associated views, data connections, and so on.
- **Delete Workbook from Favorites**: Deletes a workbook from a user's favorites. If the specified workbook is not a favorite of the specified user, this call has no effect.
- **Delete Workbook Permission (Group)**: Deletes the specified permission from the specified workbook for a group or user.
- **Delete Workbook Permission (User)**: Deletes the specified permission from the specified workbook for a group or user.
- **Delete Work Copy Elements**: Deletes elements from a work copy. Send elementType and name for each element. Other content is ignored. Returns HTTP 200 when every element is deleted. The success body omits the elements that succeeded.
- **Download Data Source**: Downloads a data source in .tdsx format.
- **Download Data Source Encrypted Keychain**: Gets an encrypted version of the embedded credentials from the data source. These credentials can only be migrated to the linked destination Tableau Cloud or Tableau Server. Before you use this method, you must create public and private keys for resources with embedded credentials.
- **Download Data Source Revision**: Downloads a specific version of a data source prior to the current one in .tdsx format. Available only if version history is enabled for the site.
- **Download Flow**: Downloads a flow in .tfl or .tflx format.
- **Download Flow Encrypted Keychain**: Gets an encrypted version of the embedded credentials in a flow. These credentials can only be migrated to the linked destination Tableau Cloud or Tableau Server. Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3).
- **Download User Credentials**: Gets credentials for a user who is being migrated to another Tableau Cloud or Tableau Server site. Before you use this method, you must create public and private keys for resources with embedded credentials. For more information, see Migrate Workbooks and Data Sources with Embedded Credentials.
- **Download View Crosstab Excel**: Downloads an Excel (.xlsx) file containing crosstab data from a view that the user has permission to access in a workbook. If a crosstab is exported from a dashboard, data from only the first view in the dashboard will appear in the .xlsx file.
- **Download Virtual Connection**: Downloads a JSON-representation of a virtual connection.
- **Download Virtual Connection Revision**: Downloads a JSON-representation of an earlier revision of a virtual connection.
- **Download Workbook**: Downloads a workbook in .twb or .twbx format. Security note: Content in .twb or .twbx files downloaded using this method is stored in plain text. All data, including filter values that may give semantic clues to the data, will be readable by anyone who opens the files.
- **Download Workbook Encrypted Keychain**: Gets an encrypted version of the embedded credentials from the workbook. These credentials can only be migrated to the linked destination Tableau Cloud or Tableau Server. Before you use this method, you must create public and private keys for resources with embedded credentials.
- **Download Workbook PDF**: Downloads a .pdf containing images of the sheets that the user has permission to view in a workbook. Download Images/PDF permissions must be enabled for the workbook (true by default). If Show sheets in tabs is not selected for the workbook, only the default tab will appear in the .pdf file.
- **Download Workbook PowerPoint**: Downloads a PowerPoint (.pptx) file containing slides with images of the sheets that the user has permission to view in a workbook. Download Images/PDF permissions must be enabled for the workbook (true by default).
- **Download Workbook Revision**: Downloads a specific version of a workbook in .twb or .twbx format. Note: This method is available only if version history is enabled for the specified site. For more information, see Security note: Content in .twb or .twbx files downloaded using this method is stored in plain text.
- **Enable or disable analytics extensions on server**: Enables or disables analytics extensions on a server.
- **Encrypt Extracts in a Site**: Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see Extract Encryption at Rest. Encrypts all extracts on a site.
- **Generate basic insight bundle**: Generates a basic insight bundle.
- **Generate breakdown insight bundle**: Generates a breakdown insight bundle. This provides the BAN and breakdown groups of insights.
- **Generate current metric value insight bundle**: Generates a bundle the current aggregated value for each metric. Version: Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. Version Overview
- **Generate detail insight bundle**: Generates a detail insight bundle.
- **Generate exploration insight bundle**: Generates an exploration insight bundle. This provides the BAN, anchor, and followup groups of insights.
- **Generate insight brief**: Generates an insight brief based on a user utterance by gathering insights for the specified metrics. For supplemental information, see Using Pulse Generate Insight Brief.
- **Generate metric card image**: Generates a PNG image of a Pulse metric card with full visual parity to the web UI homepage.
- **Generate springboard insight bundle**: Generates a springboard insight bundle.
- **Get analytics extension details**: Get the details of a specified analytics extension connection to an external service.
- **Get a node by ID**: Get a single node by its ID, including its semantic statements and directly connected nodes.
- **Get a Webhook**: Returns information about the specified webhook.
- **Get batch content usage statistics**: Gets usage statistics for multiple content items. The batch of can include multiple content types.
- **Get Bridge Client**: Retrieves detailed information about a single Bridge client. Lookup is site-scoped.
- **Get Connected App**: Query a connected app by its ID. Note: The connected-applications endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release.
- **Get Connected App Secret**: Query a connected app secret and the token value using the connected app's ID. Secrets are tokens shared by Tableau and a custom application, and used to establish a trusted relationship. A maximum of two secrets can be associated with a connected app.
- **Get content search results**: Searches across all supported content types for objects relevant to the search expression specified in the querystring of the request URI.
- **Get Content Suggestions**: Returns a specified number of suggestions for auto-completion of user input as they type. You can specify content types of suggestions and prioritize recently viewed content.
- **Get current analytics extension for workbook**: Gets basic details, including connection type and name, of the analytics extension connection to an external service that the specified workbook is currently using.
- **Get Current Server Session**: Returns details of the current session of Tableau Server.
- **Get Custom Domain Name**: Gets the custom domain for a Tableau site, if one is provisioned. For more information about how, see Using Custom Domains.
- **Get custom domain settings**: Gets the custom domain settings for a Tableau site.
- **Get Custom View**: Gets the details of a specified custom view.
- **Get Custom View Data**: Returns a specified custom view rendered as data in comma separated value (CSV) format, in the response body rather than as a download.
- **Get Custom View Image**: Downloads an image file of the specified custom view.
- **Get Custom View PDF**: Returns a specified custom view rendered as a .pdf file. If you make multiple requests for a PDF, subsequent calls return a cached version of the file. This means that the returned PDF might not include the latest changes to the custom view.
- **Get Databases and Tables from Connection**: Query databases and tables from the connection information in the data source (.tds or .tdsx) or workbook (.tws or .twbx) file's XML. Note: This method can't be used to query databases and tables when the database is an embedded asset.
- **Get Data-Driven Alert**: Returns details on a specified data-driven alert, including the recipients of the alert.
- **Get Data Source Revisions**: Returns a list of revision information (history) for the specified data source. Note: This method is available only if version history is enabled for the specified site. For more information, see Maintain a History of Revisions in the Tableau Server Help.
- **Get details of a collection**: Gets the details of a collection.
- **Get Domain Mapping**: Retrieves information about all domain mappings for the site, including pool assignment and status (ALLOWED or BLOCKED). When status is ALLOWED, poolId is the pool UUID; when BLOCKED, poolId is the string "BLOCKED". URL-encode special characters in domain names in the request.
- **Get Embedding Settings for a Site**: Returns the current embedding settings for a specific site. Embedding settings can be used to restrict embedding Tableau views to only certain domains. This setting impacts all embedding scenarios including, Tableau Javascript API v2, Embedding API v3, and the embed code from the share dialog.
- **Get enabled state of analytics extensions on server**: Gets the enabled/disabled state of analytics extensions on a server.
- **Get enabled state of analytics extensions on site**: Gets the enabled/disabled state of analytics extensions on a site.
- **Get Extract Refresh Task**: Returns information about the specified extract refresh task. This method shows you information about the scheduled task for the data source extract or a published workbook that connects to the data extract.
- **Get Favorites for User**: Returns a list of favorite projects, data sources, views, workbooks, and flows for a user.
- **Get Flow Run**: Gets a flow run.
- **Get Flow Runs**: Get flow runs.
- **Get Flow Run Task**: Returns information about the specified flow run task. This method shows you information about the scheduled task for the flow.
- **Get Flow Run Tasks**: Returns a list of scheduled flow tasks for the site.
- **Get graph-health suggestions**: Get a report on the health of the graph, including a score and suggested improvements.
- **Get Group Set**: Returns information about the specified group set including ID, name, and member groups.
- **Get Groups for a User**: Gets a list of groups of which the specified user is a member.
- **Get Identity Pool**: Get information about an identity pool.
- **Get Label**: Gets a data label by its LUID. For more information on data label objects and properties, see the Data Labels in the REST API topic. All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license.
- **Get Labels**: Displays information about the data labels on one or more assets. You can optionally limit the data labels to show by category using a query string. For more information on data label objects and properties, see the Data Labels in the REST API topic.
- **Get labelValue**: Displays label value properties for a single label value. Note that a label value (labelValue) is one property of a label. A label value has its own properties like name, category, and description that determine label behavior and options that users see in label dialogs.
- **Get Linked Task**: Returns information about a specific linked task.
- **Get Linked Tasks**: Returns a list of scheduled linked tasks for a site.
- **Get Metadata Suggestion**: Gets a suggestion from generative AI about asset metadata. As of June 2024, the type of suggestion is limited to the description for a workbook, data source, or table. Generative AI suggests a description based on the chosen asset's metadata, such as asset name, field names, and/or column names.
- **Get metric**: Gets the details of the specified metric.
- **Get metric definition**: Gets a metric definition and optionally metrics it contains.
- **Get Mobile Security Settings for Server**: Gets the mobile security settings for the server.
- **Get Mobile Security Settings for Site**: Gets the mobile security settings for the specified site.
- **Get OpenID Connect Configuration**: Get details about the Tableau Cloud site's OpenID Connect (OIDC) configuration. Note: The resource, GET /api/{api-version}/sites/{site-luid}/site-oidc-configuration?idpConfigurationId={idpConfigurationId}, was added in version 3.24.
- **Get or create metric**: Returns the details of a metric in a definition if it exists, or creates a new metric if it does not. Also returns 'true' if a new metric was created, or 'false' if it already existed.
- **Get Pulse subscription**: Gets a specified subscription to a metric.
- **Get Recently Viewed for Site**: Gets the details of the views and workbooks on a site that have been most recently created, updated, or accessed by the signed in user. The 24 most recently viewed items are returned, though it may take some minutes after being viewed for an item to appear in the results.
- **Get Recycle Bin Content Item**: Returns information about the specified Recycle Bin content item. Administrators can see any content in the site's Recycle Bin. Other users can only see the content they own.
- **Get Routing Rule**: Returns a single Bridge routing rule identified by its ID. The {routing-rule-id} must be a valid UUID and reference a rule that exists on the specified site; a rule from another site is not returned. If no rule matches, a 404 error is returned. This method is not available for Tableau Server.
- **Get Routing Rules**: Returns all Bridge routing rules for the site. Both allow rules and block rules are returned in a single routingRules list; the isBlocked flag distinguishes them. A site with no routing rules returns an empty routingRules container.
- **Get SCIM Configuration**: Gets the System for Cross-domain Identity Management (SCIM) configuration on the Tableau Cloud site.
- **Get Server Schedule**: Returns detailed information about the specified server schedule on Tableau Server. Not available for Tableau Cloud.
- **Get site entitlements**: Returns entitlements available for a site. If entitlements are True, then Pulse premium features are enabled for the site.
- **Gets recommended metrics**: Gets personalized groups of metrics to recommend to a user. Only metric that the user has privileges to view will be returned.
- **Get Subscription**: Returns information about the specified subscription.
- **Get Tableau MCP Settings for Site**: Gets the list of Tableau MCP settings for a specified site. For more information about configuring the Tableau MCP settings for a site, see Site settings for Tableau MCP.
- **Get the downstream impact of a node**: Get the assets that depend on a node, to see the impact if it changes.
- **Get the lineage of a node**: Get the lineage neighborhood of a node.
- **Get usage statistics for content item**: Gets the usage statistics for a Tableau content item, specified by LUID and content type, such as workbook, datasource, or flow.
- **Get User Notification Preferences**: Returns the notification preferences for the specified site. You can filter by channel and notification type. For more information about notifications, see Manage Your Account Settings.
- **Get User Personal Space**: Gets the details of the Personal Space for the currently authenticated user. Personal Space must be enabled for the site in order to be returned by this method.
- **Get Users in Group**: Gets a list of users in the specified group.
- **Get Users on Site**: Returns the users associated with the specified site.
- **Get View**: Gets the details of a specific view.
- **Get View by Path**: Gets the details of all views in a site with a specified name.
- **Get Workbook**: Returns information about the specified workbook, including information about views and tags.
- **Get Workbook Downgrade Info**: Returns a list of the features that would be impacted, and the severity of the impact, when a workbook is exported as a downgraded version (for instance, exporting a v2019.3 workbook to a v10.5 version).
- **Get Workbook Revisions**: Returns a list of revision information (history) for the specified workbook. Note: This method is available only if version history is enabled for the specified site. To get a specific version of the workbook from revision history, use the Download Workbook Revision method.
- **Import Users to Site from CSV**: Creates a job to import the users listed in a specified .csv file to a site, and assign their roles and authorization settings.
- **Initiate File Upload**: Initiates the upload process for a file. After the upload has been initiated, you call Append to File Upload to send individual blocks of the file to the server. When the complete file has been sent to the server, you call Publish Data Source, Publish Flow, or Publish Workbook to commit the upload.
- **List All Registered EAS**: Get all external authorization servers (EASs) registered to a site.
- **List analytics extension connections of workbook**: Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name.
- **List analytics extension connections on site**: Lists a site's analytics extension connections for external services.
- **List Authentication Configurations for Site**: List all authentications configurations on the site. For more information, see Authentication in the Tableau Cloud Help.
- **List Authentication Configurations on Server**: List information about all authentication instances associated with identity pools.
- **List Bridge Clients**: Retrieves a list of all Bridge clients for a specific site, with optional filtering by pool. Only one filter (poolId, onlyDefaultPool, or onlyUnassigned) can be specified at a time. Each client is in one of three states: assigned to a named pool, assigned to the default pool, or unassigned.
- **List Bridge Pools**: Retrieves a list of all Bridge pools for the specified site, including pool details and associated domain mappings. Each pool includes its ID, display name, and domains with status ALLOWED or BLOCKED. There is no pagination; consider caching results for 5–15 minutes for large deployments.
- **List Collection Permissions**: Returns a list of permissions for a specific collection.
- **List collections**: Lists collections.
- **List Connected Apps**: Query all connected apps configured on a site. Note: The connected-applications endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release.
- **List Custom Views**: Gets a list of custom views on a site. The list includes details of each custom view.
- **List Database Permissions**: Get information about the permissions on a database asset.
- **List Data-Driven Alerts on Site**: Returns a list of data-driven alerts in use on the specified site.
- **List Data Source Permissions**: Returns a list of permissions for a specific data source.
- **List Default Database Permissions**: Get the default permissions applied to the database asset and its children tables. Note: If a database is in a project, default database permissions are not evaluated to determine table permissions. Use Query Default Permissions to see default permissions for projects instead.
- **List Default Permissions**: Returns details of default permission rules granted to users and groups for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group.
- **List edges around a node**: List the edges connected to a node.
- **List Extract Refresh Tasks in Server Schedule**: Returns a list of the extract refresh tasks for a specified server schedule on the specified site on Tableau Server. To get the ID of a schedule, call the List Server Schedules method. Note that the List Server Schedules method is global to the server; schedules are not specific to a site.
- **List Extract Refresh Tasks in Site**: Returns a list of extract refresh tasks for the site. This method shows you information about the scheduled tasks on the specified site for data source extracts or a published workbooks that connect to data extracts.
- **List Flow Permissions**: Returns a list of permissions for the specific flow.
- **List followed metrics groups**: Gets the user's followed metrics. Optionally metrics can be grouped by characteristics like datasource, and sorted.
- **List Group Sets**: Lists all group sets matching optional filter and ordered by optional sort expression.
- **List Identity Pools**: List all identity pools.
- **List Identity Stores**: List information about all identity store instances used to provision users.
- **List items in a collection**: Lists items in a collection.
- **List knowledge graphs**: List the knowledge graphs on the caller's Tableau site, each with its ID, name, description, status, and `is_primary` flag.
- **List knowledge sources**: List the data sources and workbooks connected to the graph.
- **List Label Categories on Site**: Lists all data label categories on the site. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description.
- **List labelValues on Site**: Lists all label values on the site. You can optionally limit the list of returned data label values using a query string in the URI. Note that a label value (labelValue) is one property of a label.
- **List metric definition measurement periods**: Gets the measurement periods for the specified metric definition.
- **List metric definitions**: Lists the metric definitions configured for a site or, optionally, the details and definition for a specific metric.
- **List metrics in definition**: Lists the metrics contained in a metric definition.
- **List Personal Access Tokens**: List all personal access tokens (PATs). If you're a site admin, list PATs of a user when you are the site admin on all sites that the PAT owner is a member of. This method is not available for Tableau Server.
- **List Project Permissions**: Returns information about the set of permissions allowed or denied for groups and users in a project.
- **List Pulse user preferences**: Gets the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI.
- **List Recycle Bin Content by Type**: Gets a list of Recycle Bin content of the specified type. Administrators can see all content in the site's Recycle Bin. Other users can only see the content they own. This method supports filtering, sorting, and pagination.
- **List Registered EAS**: Get an external authorization server (EAS) registered to a site.
- **Lists all definition tags for the site**: Lists all definition tags for the site. Results can be filtered by tag value, definition name, or datasource ID. Each result includes the tag value and a count of how many definitions use it.
- **List SCIM Configurations**: Returns the System for Cross-domain Identity Management Configuration (SCIM) configurations on the Tableau Cloud site.
- **List Server Active Directory Domains**: Returns the details of the Active Directory domains that are in use on the server, including their full domain names, nicknames and IDs. If the server is configured to use local authentication, the command returns only the domain name local.
- **List Server Schedules**: Returns a list of flows, extract and subscription server schedules on Tableau Server. For each schedule, the API returns the name, frequency, priority, and other information. For more information about schedules, see Create or Modify a Schedule. Not available for Tableau Cloud.
- **List site alerts**: List the alerts for the authorized user user on a specified site.
- **List Subscriptions**: Returns a list of all the subscriptions on the specified site.
- **List subscriptions (Pulse)**: Lists the subscriptions to a specified metric and/or for a specified user.
- **List Tableau extensions server settings**: Lists the settings for extensions of a server.
- **List Tableau extensions site settings**: Lists the settings for extensions of a site.
- **List Table Permissions**: Get information about the permissions on a table asset.
- **List Users with Custom View as Default**: Gets the list of users whose default view is the specified custom view.
- **List View Permissions**: Returns a list of permissions for the specific view.
- **List Virtual Connection Database Connections**: Returns information about database connections in the specified virtual connection
- **List Virtual Connection Permissions**: Returns a list of permissions for a specific virtual connection.
- **List Virtual Connection Revisions**: Lists revisions for a virtual connection. Note: This method can only succeed if version history is enabled for the specified site. For more information, see Maintain a History of Revisions in the Tableau Server Help.
- **List Virtual Connections**: Returns a list of available virtual connection names and IDs.
- **List Webhooks**: Returns a list of all the webhooks on the specified site.
- **List Workbook Permissions**: Returns a list of permissions for the specific workbook.
- **Move Bridge Client**: Moves a Bridge client between pools or to unassigned status. The operation is atomic (all-or-nothing). For moveToNamedPool the pool must exist and be a valid UUID; moveToUnassigned is useful for temporarily deactivating a client without deleting it. This method is not available for Tableau Server.
- **Move Database**: Move one or more databases to a project. You can move the database and its tables, or move only the database. To move a table independently of its database, use the Move Table method.
- **Move Table**: Moves one or more tables to a project. Note: Starting in Tableau Cloud June 2022 and Tableau Server 2022.3, projects can contain databases and tables, and database and table permissions can be managed at the project level through inheritance.
- **Organize Favorites**: Move an item to organize a user's favorites.
- **Publish Data Source**: Publishes a data source on the specified site, or appends data to an existing data source. To make other changes to a published data source, call Update Data Source or Update Data Source Connection. Note: The queryTaggingEnabled attribute is returned only for administrator users.
- **Publish Flow**: Publishes a flow on the specified site. To make other changes to a published flow, call Update Flow or Update Flow Connection. Scope added in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). You can publish a flow in a single request or in multiple parts.
- **Publish Virtual Connection**: Publishes a downloaded JSON-representation of a virtual connection. If the virtual connection does not exist, it will be published as a new virtual connection.
- **Publish Workbook**: Publishes a workbook on the specified site. To make changes to a published workbook, call Update Workbook or Update Workbook Connection. This method is used in two ways. You can call it to publish a workbook in a single request.
- **Publish Work Copy**: Publishes a work copy as a data source. Send the published data source name and an optional description. The response returns the new data source LUID. A blank name is rejected.
- **Query All Quality Warning Triggers by Content**: Get information about all quality warning triggers for a content item.
- **Query Column in a Table**: Get information about a column in a table asset.
- **Query Columns in a Table**: Get information about the columns in a table asset.
- **Query Database**: Get information about a database asset.
- **Query Databases**: Get information about all database assets for a site.
- **Query Data Quality Certification by ID**: Get information about a data quality certification. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Query Data Quality Certifications by Content**: Get all data quality certifications for content or asset items. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Query Data Quality Warning by Content**: Get information about the data quality warning for the database, table, column, published data source, flow, virtual connection, or virtual connection table. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods.
- **Query Data Quality Warning by ID**: Get information about a specific data quality warning. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Query Data Source**: Returns information about the specified data source.
- **Query Data Source Connections**: Returns a list of data connections for the specified data source.
- **Query Data Sources**: Returns a list of published data sources on the specified site, with optional parameters for specifying the paging of large results. To get a list of data sources embedded in a workbook, use the Query Workbook Connections method.
- **Query Data Source (VizQL Data Service)**: Query a published data source and get rows back without a visualization.
- **Query Flow**: Returns information about the specified flow, including information about the project, owner, and output steps.
- **Query Flow Connections**: Returns a list of data connections for the specific flow.
- **Query Flows for a Site**: Returns the flows on a site. If the user is not an administrator, the method returns just the flows that the user has permissions to view.
- **Query Flows for User**: Returns the flows that the specified user owns in addition to those that the user has Read (view) permissions for.
- **Query Groups**: Returns a list of groups on the specified site, with optional parameters for specifying the paging of large results.
- **Query Job**: Returns status information about an asynchronous process that is tracked using a job. This method can be used to query jobs that are used to do the following: Import users from Active Directory (the result of a call to Create Group).
- **Query Jobs**: Returns a list of active jobs on the specified site, optionally filtered. Pass a job ID to Query Job for details or to Cancel Job to cancel it.
- **Query Metadata API (GraphQL GET)**: Run a GraphQL query against the Metadata API using a query string.
- **Query Metadata API (GraphQL POST)**: Run a GraphQL query against the Tableau Metadata API.
- **Query Projects**: Returns a list of projects on the specified site, with optional parameters for specifying the paging of large results.
- **Query Quality Warning Trigger**: Get information about a quality warning trigger.
- **Query Site**: Returns information about the specified site, with the option to return information about the storage space and user count for the site. You can specify the site to delete by using the site ID, the site name, or the content URL.
- **Query Sites**: Returns a list of the sites on the server that the caller of this method has access to. This method is not available for Tableau Cloud.
- **Query Table**: Get information about a table asset.
- **Query Tables**: Get information about all table assets for a site.
- **Query User On Site**: Returns information about the specified user.
- **Query View Data**: Returns a specified view rendered as data in comma separated value (CSV) format. CSV data is provided in the response body, rather than as a download. If the request is for a dashboard, only data for the dashboard's first view is returned.
- **Query View Image**: Downloads an image file of the specified view. If you make multiple requests for an image, subsequent calls return a cached version of the image. This means that the returned image might not include the latest changes to the view.
- **Query View PDF**: Returns a specified view rendered as a .pdf file. If you make multiple requests for a PDF, subsequent calls return a cached version of the file. This means that the returned PDF might not include the latest changes to the view.
- **Query View Preview Image**: Returns the thumbnail image for the specified view.
- **Query Views for Site**: Returns all the views for the specified site, optionally including usage statistics.
- **Query Views for Workbook**: Returns all the views for the specified workbook, optionally including usage statistics.
- **Query Workbook Connections**: Returns a list of data connections for the specific workbook.
- **Query Workbook Preview Image**: Returns the thumbnail image as a PNG file for the specified workbook. Usually the image that is returned is for the first sheet in the workbook.
- **Query Workbooks for Site**: Returns the workbooks on a site. If the user is not an administrator, the method returns just the workbooks that the user has permissions to view.
- **Query Workbooks for User**: Returns the workbooks that the specified user owns in addition to those that the user has Read (view) permissions for.
- **Read Data Source Elements**: Reads columns, field descriptions, or table descriptions from a published data source. Set elementType to the kind of element, and optionally set name to read one element. A missing named element returns HTTP 404.
- **Read Data Source Metadata (VizQL Data Service)**: List the fields of a data source that can be used in VizQL Data Service queries.
- **Read Work Copy Elements**: Reads columns, field descriptions, or table descriptions from a work copy. Set elementType to the kind of element, and optionally set name to read one element. A missing named element returns HTTP 404.
- **Reencrypt Extracts in a Site**: Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see Extract Encryption at Rest. Reencrypt all extracts on a site with new encryption keys.
- **Register EAS**: Create a connected app with OAuth 2.0 trust by registering an external authorization server (EAS) to a site. You can register an external authorization server (EAS) to establish a trust relationship between your Tableau Server site or Tableau Cloud site and EAS using the OAuth 2.0 standard protocol.
- **Remove Column**: Permanently remove the column from a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Remove current analytics extension connection for workbook**: Remove the currently used analytics extension connection to an external service from the specified workbook. The connection remains configured, and is available for further usage by the workbook.
- **Remove Database**: Permanently remove the database asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Remove Data Source Revision**: Removes a specific version of a data source from the specified site. The content is removed, and the specified revision can no longer be downloaded using Download Data Source Revision.
- **Remove Group from Group Set**: Removes a group from the specified group set.
- **Remove items from a collection**: Removes items from a collection.
- **Remove OpenID Connect Configuration**: Disable and clear the Tableau Cloud site's OpenID Connect (OIDC) configuration. Important: Before removing the OIDC configuration, make sure that users who are set to authenticate with OIDC are set to use a different authentication type.
- **Remove Projects from Routing Rule**: Removes one or more project filtering conditions from an existing allow rule, broadening the rule so it no longer applies only to those projects. This method applies to allow rules only; removing projects from a block rule is rejected. Each project ID must be a valid UUID.
- **Remove Table**: Permanently remove the table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Remove User from Group**: Removes a user from the specified group. Beginning in API 3.21, you can bulk remove users from a group by specifying multiple user IDs.
- **Remove User from Identity Pool**: Remove a user from a specified identity pool. This method is not available for Tableau Cloud.
- **Remove User from Site**: Removes a user from the specified site. The user will be deleted if they do not own any other assets other than subscriptions. If a user still owns content (assets) on Tableau Server, the user cannot be deleted unless the ownership is reassigned first.
- **Remove Users from Group in Bulk**: Removes a user from the specified group. Beginning in API 3.21, you can bulk remove users from a group by specifying multiple user IDs.
- **Remove Workbook Revision**: Removes a specific version of a workbook from the specified site. The content is removed, and the specified revision can no longer be downloaded using Download Workbook Revision. If you call Get Workbook Revisions, the revision that's been removed is listed with the attribute IsDeleted="true".
- **Reorder items in a collection**: Reorders items in a collection.
- **Replace Data Source Permissions**: Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call.
- **Replace Flow Permissions**: Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call.
- **Replace Project Permissions**: Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call.
- **Replace Project's Default Permissions**: Replaces default permissions in the specified content. If Tableau Catalog is enabled, it also adds default permission rules for database or table resources in a project.
- **Replace View Permissions**: Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call.
- **Replace Workbook Permissions**: Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call.
- **Restore Recycle Bin Content Item**: Restores the specified content item from the Recycle Bin to a project. Administrators can restore any content from the site's Recycle Bin. Other users can only restore content they own, and need Publish permission for the project they're restoring to.
- **Revoke Administrator Personal Access Tokens**: Revokes all personal access tokens (PATs) created by server administrators. This method is not available for Tableau Cloud.
- **Revoke Personal Access Token**: Revoke a personal access token (PAT). If you're a site admin, you can revoke a users PAT owhen you are the site admin on all sites that the PAT owner is a member of. This method is not available for Tableau Server.
- **Run Extract Refresh Task**: Runs the specified extract refresh task. Note: This method will fail and result in an error if your Server Administrator has disabled the RunNow setting for the site. For more information, see Tableau Server Settings.
- **Run Flow Now**: Runs the specified flow. This method runs the specified flow with all the output steps if none are specified. If you want to run only a subset of output steps, you can specify one or more output steps using the output-ids by using the List Metrics for Site - Retired in API 3.22.
- **Run Flow Task**: Runs the specified flow run task. Note: - This method is unavailable if you don't have Data Management. For more information, see Tableau Prep Conductor. - This method will fail and result in an error if your Server Administrator has disabled the RunNow setting for the site.
- **Run Linked Task Now**: Runs the specified linked task. This method runs the specified linked task with all the steps. Depending on the setting that the task was created with, the linked task will stop at a step on failure or continue to the next step. For more information, see schedule linked tasks.
- **Search graph nodes**: Search graph nodes using natural-language semantic search.
- **Search semantic contexts**: Search semantic contexts across the graph.
- **Search semantic contexts attached to a node**: Search the semantic contexts attached to a specific node.
- **Server Info**: Returns the version of Tableau Server and the supported version of the REST API.
- **Set Custom View as Default for Users**: Sets the specified custom for as the default view for up to 100 specified users. Success or failure for each user is reported in the response body.
- **Sign In**: Exchange a personal access token for a session token (X-Tableau-Auth) used on every other call.
- **Sign Out**: Invalidate the current session token.
- **Switch Site**: Switches you onto another site without having to provide a user name and password again. This method allows an authenticated user to switch sites that they have access to. When you call this method, you must provide the current authorization token as the value of the X-Tableau-Auth header.
- **Test a Webhook**: Tests the specified webhook. Sends an empty payload to the configured destination URL of the webhook and returns the response from the server. This is useful for testing, to ensure that things are being sent from Tableau and received back as expected.
- **Update analytics extension connection of site**: Updates the details of specified analytics extension connection for an external service to a site.
- **Update analytics extension for workbook**: Updates the analytics extension connection to external service currently used by a workbook.
- **Update a semantic context**: Partially update a semantic context.
- **Update Authentication Configuration**: Update an authentication instance. Note: The request body must specify all the required and desired parameters, not jus the parameters you want to update.
- **Update a Webhook**: Modify the properties of an existing webhook.
- **Update Bridge Pool**: Updates the display name of an existing Bridge pool. The pool ID and domain/Bridge client assignments are unchanged. This method is not available for Tableau Server.
- **Update Cloud Extract Refresh Task**: Updates a custom schedule for an extract refresh task on Tableau Cloud. For Tableau Server, see Update server schedule.
- **Update Column**: Update the description of the column. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Update Connected App**: Update a connected app. Note: The connected-applications endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release.
- **Update custom domain settings**: Updates the custom domain setup for a Tableau site. For more information, see Setup Steps to Enable a Custom Domain.
- **Update Custom View**: Changes the owner or name of an existing custom view.
- **Update Database**: Update the database description, certify a database, set database permissions, or assign a Tableau Cloud or Server user as the database contact. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Update Data-Driven Alert**: Update one or more settings for the specified data-driven alert; including the alert subject, frequency, and owner.
- **Update Data in Hyper Connection**: Incrementally updates data (insert, update, upsert, replace and delete) in a published data source from a live-to-Hyper connection, where the data source has multiple connections. A live-to-Hyper connection has a Hyper or Parquet formatted file/database as the origin of its data.
- **Update Data in Hyper Data Source**: Incrementally updates data (insert, update, upsert, replace and delete) in a published data source from a live-to-Hyper connection, where the data source has a single connection. A live-to-Hyper connection has a Hyper or Parquet formatted file/database as the origin of its data.
- **Update Data Quality Warning**: Update the warning type, status, and message of a data quality warning. Note: Data quality warnings and certifications can be more generally managed through the newer Labels methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed.
- **Update Data Source**: Updates the owner, project or certification status of the specified data source.
- **Update Data Source Connection**: Updates the server address, port, authentication type, username, or password for the specified data source connection. If the data source contains multiple connections, all the connections are updated.
- **Update Data Source Connections**: Updates the server address, port, authentication type, username, or password for one or more connections in a data source. To update all connections in a given data source with the same connection information, see Update Data Source Connection.
- **Update Data Source Now**: Runs an extract refresh on the specified data source. Note: This method will fail and result in an error if your Server Administrator has disabled the RunNow setting for the site. For more information, see Tableau Server Settings.
- **Update Domain Among Pools**: Moves a domain from its current pool to a different pool. The operation is atomic (all-or-nothing); on failure the domain mapping is unchanged. This method is not available for Tableau Server.
- **Update Domain Name**: Updates an existing domain mapping by renaming the domain. The operation is atomic (all-or-nothing). This method is not available for Tableau Server.
- **Update EAS**: Update a connected app with OAuth 2.0 trust. Notes: Beginning in API version 3.22, you can register multiple EASs per site for Tableau Cloud. Beginning in API version 3.23, Tableau Server supports site-level EAS (and multiple registrations of EASs per site).
- **Update Embedding Settings for Site**: Updates the embedding settings for a site. Embedding settings can be used to restrict embedding Tableau views to only certain domains. This setting impacts all embedding scenarios including Tableau Javascript API v2, Embedding API v3, and the embed code from the share dialog.
- **Update enabled state of analytics extensions on site**: Enables or disables analytics extensions on a site.
- **Update Flow**: Updates the project and/or owner of the specified flow. To change the flow owner with fewer limitations on who the new owner can be, use the Update Flow Owner method instead.
- **Update Flow Connection**: Updates the server address, port, username, or password for the specified flow connection. The connection can be an input or an output connection.
- **Update Flow Connections**: Updates the server address, port, username, or password for one or more flow connections. The connection can be an input or an output connection.
- **Update Flow Owner**: Updates a flow's owner. If the same user owns all the flows in a linked task, this method also changes the ownership of the linked task to that user. This method overlaps in function with Update Flow method, but has fewer limitations on who the new owner can be.
- **Update Group**: Updates a group on a Tableau Cloud site or Tableau Server. Tableau Cloud If the Tableau Cloud site is configured to use local authentication, the method lets you update the group name.
- **Update Group Set**: Updates a group set name on a Tableau Server or Tableau Cloud site.
- **Update Identity Pool**: Update information about an identity pool.
- **Update Label**: Updates a label by its LUID. This method can update the label value, message, active flag, and elevated flag. You can't update the label category. If you choose a label value name that's associated with a different category, you get an error.
- **Update Label Category**: Updates a data label category. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs.
- **Update Labels**: Creates or updates labels on one or more assets. Each asset listed in the request body is updated to have a label with the specified value, message, active flag, and elevated flag.
- **Update labelValue**: Updates a label value. Note: You can update an existing label value using either this method or the Create or Update labelValue method. If you want to change the name of an existing label value, use this method. Note that a label value (labelValue) is one property of a label.
- **Update metric**: Updates the specification of a metric.
- **Update metric definition**: Updates a metric definition.
- **Update Mobile Security Settings for Site**: Updates the mobile security sections for a specified site.
- **Update Monitoring Quality Warning**: Update a monitoring quality warning. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Update OpenID Connect Configuration**: Update the Tableau Cloud site's OpenID Connect (OIDC) configuration.
- **Update Project**: Updates the name, description, or project hierarchy of the specified project. You can create or update project hierarchies by specifying a parent project for the project that you are updating using this method.
- **Update Pulse user preferences**: Updates the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI.
- **Update Routing Rule**: Partially updates an existing Bridge routing rule. You can change the rule's domain, poolId, and isBlocked flag. At least one attribute must be supplied; only the supplied attributes are changed.
- **Update SCIM Configuration**: Updates the System for Cross-domain Identity Management (SCIM) configuration on the Tableau Cloud site. You must be the user that created the SCIM configuration to update the SCIM configuration unless the creator of the SCIM configuration is no longer a member of the site.
- **Update Server Active Directory Domain**: Changes the nickname or full domain name of an Active Directory domain on the server. This method is not available on Tableau Cloud. A domain nickname, also called short name, is the Windows NetBIOS domain name. You can modify the nickname for any domain the server is using.
- **Update Server Schedule**: Modifies settings for the specified server schedule, including the name, priority, and frequency details on Tableau Server. For Tableau Cloud, see Update cloud extract refresh task and Update subscription .
- **Update Site**: Modifies settings for the specified site, including the content URL, administration mode, user quota, state (active or suspended), storage quota, whether flows are enabled, whether subscriptions are enabled, and whether revisions are enabled.
- **Update Subscription**: Modifies an existing subscription on Tableau Server. You can change the subject, server schedule, and suspension state for the subscription. Tableau Server and Tableau Cloud each have a different model for schedules and tasks. On Tableau Server, you create a schedule and add a task to it.
- **Update Table**: Update the table description, certify a table, or a assign a user contact to the table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management.
- **Update Tableau extensions server settings**: Updates the settings for extensions of a server.
- **Update Tableau extensions site settings**: Updates the settings for extensions of a site.
- **Update Tableau MCP Settings for Site**: Updates the current list of Tableau MCP settings for a specified site. For more information about configuring the Tableau MCP settings for a site, see Site settings for Tableau MCP.
- **Update User**: Modifies information about the specified user. Tableau Server If Tableau Server is configured to use local authentication, you can update the user's name, email address, password, or site role.
- **Update User Notification Preferences**: Updates user notifications preferences to enabled or disabled on the specified site. For more information about notifications, see Manage Your Account Settings.
- **Update Virtual Connection**: Updates a virtual connection's name, owner, project, or certification status.
- **Update Virtual Connection Database Connections**: Updates the server address, port, username, or password for the specified database connection in a virtual connection.
- **Update Workbook**: Modifies an existing workbook, allowing you to change the owner or project that the workbook belongs to and whether the workbook shows views in tabs. Updated workbooks can optionally be marked to appear in the recently viewed list. You can manage Data Freshness Policy for a workbook, and enable View
- **Update Workbook Connection**: Updates the server address, port, authentication type, username, or password for the specified workbook connection. If the workbook contains multiple connections to the same data source type, all the connections are updated.
- **Update Workbook Connections**: Updates the server address, port, authentication type, username, or password for one or more connections in a data source. To update all connections in a given data source with the same connection information, see Update Workbook Connection.
- **Update Workbook Now**: Refreshes the specified workbook. This method refreshes the specified workbook, with no need to associate the workbook refresh with a scheduled task.
- **Update Workbook Thumbnail Images**: Updates a workbook's thumbnail images. The method adds a task to the backgrounder queue. Depending upon the length of the queue, the task might not run immediately.
- **Update Work Copy Elements**: Updates columns, field descriptions, or table descriptions on a work copy. Returns HTTP 200 when every element is updated. The success body omits the elements that succeeded. A column update may set at most one of caption, type, or role. An unknown type or role is HTTP 400 with error code 400008.
- **Upload Data Source Encrypted Keychain**: Uploads the encrypted version of the embedded credentials. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site.
- **Upload Flow Encrypted Keychain**: Uploads the encrypted version of the embedded credentials of a flow. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site.
- **Upload User Credentials**: Uploads user credentials to a site on a destination Tableau Cloud or Tableau Server. Before you use this method, you must create public and private keys for resources with embedded credentials. For more information, see Migrate Workbooks and Data Sources with Embedded Credentials.
- **Upload Workbook Encrypted Keychain**: Uploads the encrypted version of the embedded credentials. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site.
- **Validate Uploaded Workbook**: Validates a Tableau workbook (TWB) file that already exists in temporary storage on Tableau Cloud or Tableau Server. The TWB is validated against the TWB XSD schema and verifies that it can be loaded in Tableau.
- **Validate Workbook**: Validates a Tableau workbook (TWB) file against the TWB XSD schema and verifies that it can be loaded in Tableau. This endpoint validates TWB file content without storing it on Tableau Cloud or Tableau Server.
- **Validate Workbook and Upload**: Validates a Tableau workbook (TWB) file against the TWB XSD schema and verifies that it can be loaded in Tableau. If validation succeeds, this method stores the TWB in a temporary location on Tableau Cloud or Tableau Server for further use.

Connect Tableau in General Input: https://www.generalinput.com/apps/tableau