Tableau

Data Visualization

Published by

Techtriq

Description

Tableau is a data visualization and business intelligence tool used to analyze and present data in a visually appealing manner. It allows users to connect to various data sources and transform raw data into meaningful insights. With its intuitive drag-and-drop interface, users can easily create interactive dashboards, charts, and reports.

Tableau provides a wide range of data visualization options, including bar charts, maps, scatter plots, and more, enabling users to explore data from different angles.

Supported Operations

Tableau REST API OpenAPI Endpoints

List ask data lenses in site

Returns a list of ask data lenses in a site. > **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by any user. Responses will include only the lenses to the user has access to. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** `tableau:lenses:read` *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Create ask data lens

Create an ask data lens. > **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users who have **Create** permissions for lenses on the site. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** `tableau:lenses:create` *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Import ask data lens

Import an existing ask data lens on a server to a site, and optionally transform the metadata of the lens in the process. > **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by server administrators or site administrators. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** `tableau:lenses:create` *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)* The request and response bodies for a lens import each have two parts: the first describes the attributes of the lens being imported, and the second describes transformations, which are changes to the lens metadata, to apply during import. Use the entire response object from a request to the [Get ask data lens method](#tag/get_data_lens) in your import request body. Lens attributes that can optionally be transformed include name, data source, project, and owner. The original metadata of a lens is replaced by the transformation metadata in the new project the lens is imported to. While `lens_transformation` is optional in an import request, a transformation definition will be needed in most cases. **Example transformation use cases** - To publish a lens to a new site with modified metadata, sign in to the new site and include the following in your request: ``` "lens_transformations": { "datasource_id": "<data_source_LUID_in_new_site>", "project_id": "<project_LUID_in_new_site>", "owner_id": "<lens_owner_LUID_in_new_site>" "name": "<new name of the lens>", "description": "<new description of the lens>", } ``` - To publish a lens to a different project in the same site, while signed in to the site, use: ``` "lens_transformations": { "project_id": "new project id", } ```

Get ask data lens

Get the details of the specified ask data lens. > **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users who have **Read** access to the lens. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** `tableau:lenses:read` *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Delete ask data lens

Delete an ask data lens. > **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users with administrator and lens owner permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** `tableau:lenses:delete` *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List Authentication Configurations

List information about all authentication instances. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Create Authentication Configuration

Create an instance of OpenID Connect (OIDC) authentication. For more information, see [Step 3: Set up authentication](https://help.tableau.com/current/server/en-us/identity_pools_manage.htm#step3) in the Tableau Server Help. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Delete Authentication Configuration

Delete an authentication instance. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List Identity Pools

List all identity pools. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Create Identity Pool

Create an identity pool. For more information, see [Step 4: Create an identity pool](https://help.tableau.com/current/server/en-us/identity_pools_manage.htm#step4) in the Tableau Server Help. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Get Identity Pool

Get information about an identity pool. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update Identity Pool

Update information about an identity pool. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List Identity Stores

List information about all identity store instances used to provision users. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Configure Identity Store

Configure a new local identity store to provision users. For more information, see [Step 2: Set up an identity store](https://help.tableau.com/current/server/en-us/identity_pools_manage.htm#step2) in the Tableau Server Help. **Note:** This identity store is in addition to the identity store you configured during Tableau Server setup. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Delete Identity Store

Delete an identity store. **Important:** You cannot delete the identity store you configured during Tableau Server setup. > **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Get batch content usage statistics

Gets usage statistics for multiple content items. The batch of can include multiple content types. > **Version:** Available in API 3.17 ( Tableau Cloud December 2022) and later. Not available for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Tableau administrators can get statistics for all content they administer. Other users can get statistics for any content they own or have at least *Read* permissions for. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.17 ( Tableau Cloud December 2022) and later. Not available for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Tableau administrators can get statistics for all content they administer. Other users can get statistics for any content they own or have at least *Read* permissions for. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Search results will be limited to those objects that the user has permissions to access. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)* For example, `MY_SERVER/api/-/search?terms=productID` could return the Sales workbook that contains a data field named `productID` as well as Superstore database containing a table with a column named `productID`. Query parameters can be combined to refine your search. For instance, the request for a search on the term "sales", for workbooks created in 2021 or later, sorted by the number of times the content has been viewed since its creation, with smallest number of views first, would look like: `/search?terms=sales&filter=type:eq:workbook&tmodifiedTime:gte:2021&sort=hitsTotal:asc` Content types returned can include: <table style="100%"><tr> <td><ul> <li>`lens`</li><li>`datasource`</li><li>`virtualconnection`</li><li>`collection`</li><li>`project`</li><li>`flow`</li><li>`datarole`</li></ul></td> <td><ul><li>`table`</li><li>`database`</li><li>`metric`</li><li>`view`</li><li>`workbook`</li><li>`simulation`</li></ul></td></tr></table>

Get enabled state of analytics extensions on server

Gets the enabled/disabled state of analytics extensions on a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Enable or disable analytics extensions on server

Enables or disables analytics extensions on a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List settings for dashboard extensions on server

Lists the dashboard extension settings of a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update dashboard extensions settings of server

Updates the settings for dashboard extensions of a server > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List blocked dashboard extensions on server

Lists the dashboard extensions on the blocked list of a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Block dashboard extension on server

Adds a dashboard extension to the block list of a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Get blocked dashboard extension on server

Gets the details of a specific dashboard extension on the blocked list of a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Unblock dashboard extension on server

Deletes a specific extension from the block list of a server. > **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Get enabled state of analytics extensions on site

Gets the enabled/disabled state of analytics extensions on a site. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update enabled state of analytics extensions on site

Enables or disables analytics extensions on a site. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List analytics extension connections on site

Lists a site's analytics extension connections for external services. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Add analytics extension connection to site

Adds an analytics extensions connection for an external service to a site. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Get analytics extension details

Get the details of a specified analytics extension connection to an external service. > **Version:** Available in API 3.11 (Tableau Cloud March 2021/ Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Can only be called by users with site or server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update analytics extension connection of site

Updates the details of specified analytics extension connection for an external service to a site. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Can only be called by users with site or server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Delete analytics extension connection from site

Deletes a specific analytics extension connection for an external service from a site. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Can only be called by users with site or server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List analytics extension connections of workbook

Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users that have permissions to the specified workbook. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users that have permissions to the specified workbook. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update analytics extension for workbook

Updates the analytics extension connection to external service currently used by a workbook. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users that have permissions to the specified workbook. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can be called by users that have permissions to the specified workbook. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List dashboard extension settings of site

Lists the dashboard extension settings of the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update dashboard extension settings of site

Updates the settings for dashboard extensions for the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

List allowed dashboard extensions on site

Lists the dashboard extensions on the safe list of the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Allow dashboard extension on site

Adds a dashboard extension to the safe list of the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** This method can only be called by users with server or site administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Get allowed dashboard extension on site

Gets the details of a specific dashboard extension on the safe list of the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Can only be called by users with site or server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Update settings for allowed dashboard extension on site

Updates the settings of a specific dashboard extension in the safe list of the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Can only be called by users with site or server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Disallow dashboard extension on site

Deletes a specific dashboard extension from the safe list of the site you are signed into. > **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Can only be called by users with site or server administrator permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

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. > **Version:** Available in API 3.19 ( Tableau Cloud March 2023 / Server 2023.1) and later. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)* > **Permissions:** Suggestions will be limited to those objects that the user has permissions to access. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)* > **License:** No additional license required. > **Access Scope:** Not available. *Access Scopes Overview: [Cloud]("https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*

Details

Preview

This item is available for early access. It is still in development and may contain experimental features or limitations.

Last Update

4 months ago

Includes

tableau-api-client

tableau-auth

Links

Tableau Website

Tableau API Docs

Getting started