Analytics Extensions Settings Methods
Enable and configure analytics extensions on sites and, for on premise installations, on servers. With these extensions you can extend Tableau dynamic calculations with languages like R and python, and with other tools and platforms. For more information, see Analytics Extensions API.
When upgrading from a server version less than 2020.2, analytics extensions must be enabled on each site even if external services were enabled on the server being upgraded. Connections for sites must be ported manually.
Using the analytics extensions settings methods you can:
- Enable and disable analytics extensions for a Tableau server (on-premise only) or for a site.
- Create and manage an extension's connections to the service hosting your custom calculations.
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) Version Overview
Permissions: This method can only be called by users with server or Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
POST {server}/api/-/settings/site/extensions/analytics/connections
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) Version Overview
Permissions: Can only be called by users with site or server administrator Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
DELETE {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}
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) Version Overview
Permissions: This method can be called by users that have permissions Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
DELETE {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection
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) Version Overview
Permissions: Can only be called by users with site or server administrator Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}
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. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/analytics/connections
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. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/server/extensions/analytics
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. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/analytics
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) Version Overview
Permissions: This method can be called by users that have permissions Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/connections
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) Version Overview
Permissions: This method can be called by users that have permissions Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection
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) Version Overview
Permissions: Can only be called by users with site or server administrator Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}
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. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/server/extensions/analytics
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. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/site/extensions/analytics
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. Version Overview
Permissions: This method can be called by users that have permissions Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection