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.

Get analytics extension details

Get the details of a specified analytics extension connection to an external service. Permissions - This method can only be called by users with server or site administrator permissions.

GET {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}

view details

List analytics extension connections on site

Lists a site's analytics extension connections for external services. Permissions- This method can be called by site and server administrators.

GET {server}/api/-/settings/site/extensions/analytics/connections

view details

Get enabled state of analytics extensions on server

Gets the enabled/disabled state of analytics extensions on a server. Permissions - This method can only be called by server administrators.

GET {server}/api/-/settings/server/extensions/analytics

view details

Get enabled state of analytics extensions on site

Gets the enabled/disabled state of analytics extensions on a site. Permissions - This method can be called by site and server administrators.

GET {server}/api/-/settings/site/extensions/analytics

view details

List analytics extension connections of workbook

Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name. Permissions - This method can be called by users that have permissions to the specified workbook.

GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/connections

view details

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. Permissions - This method can be called by users with authoring access to the workbook.

GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection

view details

Add analytics extension connection to site

Adds a connection to an external service for analytics extensions on this site. Permissions - This method can be called by site and server administrators.

POST {server}/api/-/settings/site/extensions/analytics/connections

view details

Delete analytics extension connection

Deletes a specific connection to an external service for analytics extensions on this site. Permissions - This method can be called by site and server administrators.

DELETE {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}

view details

Get analytics extension details

Get the details of a specified analytics extension connection to an external service. Permissions - This method can only be called by users with server or site administrator permissions.

GET {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}

view details

List analytics extension connections on site

Lists a site's analytics extension connections for external services. Permissions- This method can be called by site and server administrators.

GET {server}/api/-/settings/site/extensions/analytics/connections

view details

Get enabled state of analytics extensions on server

Gets the enabled/disabled state of analytics extensions on a server. Permissions - This method can only be called by server administrators.

GET {server}/api/-/settings/server/extensions/analytics

view details

Get enabled state of analytics extensions on site

Gets the enabled/disabled state of analytics extensions on a site. Permissions - This method can be called by site and server administrators.

GET {server}/api/-/settings/site/extensions/analytics

view details

List analytics extension connections of workbook

Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name. Permissions - This method can be called by users that have permissions to the specified workbook.

GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/connections

view details

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. Permissions - This method can be called by users with authoring access to the workbook.

GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection

view details

Update analytics extension connection

Updates a specific connection to an external service for analytics extensions on this site. Permissions - This method can be called by site and server administrators.

PUT {server}/api/-/settings/site/extensions/analytics/connections/{connection_luid}

view details

Enable/disable analytics extensions on server

Enables or disables analytics extensions on a server. Permissions - This method can only be called by server administrators. Availability - This method is not available for Tableau Online.

PUT {server}/api/-/settings/server/extensions/analytics

view details

Update enabled state of analytics extensions on site

Enables or disables analytics extensions on a site. Permissions - This method can be called by site and server administrators. Availability - This method is not available for Tableau Online.

PUT {server}/api/-/settings/site/extensions/analytics

view details


Thanks for your feedback!