tableau
Module tableau
API
Definitions
ballerinax/tableau Ballerina library
Overview
The Tableau API v3.11 connector(https://help.tableau.com/current/api/rest_api/en-us/REST/TAG/index.html) OpenAPI specification. The Tableau API is a collection of endpoints for Tableau which is an excellent data visualization and business intelligence tool used for reporting and analyzing vast volumes of data.
Key Features
- Programmatic access to create and manage resources via REST API
- Access analytics, reports, and performance metrics
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Setup guide
To use this connector, you need to have a Tableau account and access to an API token.
- Create a Tableau account
- Obtain tokens by following this guide
Clients
tableau: Client
Versions: Tableau Server 2021.1 / Tableau Online March 2022 and later
This documentation describes the growing number OpenAPI endpoints being released alongside more than 150 classic REST endpoints that are currently in wide usage in the Tableau community.
There are some differences users of the classic endpoints will recognize when viewing these new endpoints.
-
Request bodies for these new REST endpoints must be formatted using JSON.
-
Endpoint URIs may contain a hyphen ('-') instead of an API version number, indicating that the resource is versioned separately from the numbered API release. For more information, see REST API and Resource Versions.
Starting in Tableau Server 2022.1 / Tableau Online March 2022, differences between releases will be noted in this reference.To view the previous version of this reference, see Tableau REST API OpenAPI Endpoints (v2021.4).
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://tableau.example.com/" - URL of the target service
analyticsextensionsserviceGetanalyticsextensionsconnection
function analyticsextensionsserviceGetanalyticsextensionsconnection(string connectionLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionitem|errorGet analytics extension details
Parameters
- connectionLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionitem|error - Successful.
analyticsextensionsserviceUpdateanalyticsextensionsconnection
function analyticsextensionsserviceUpdateanalyticsextensionsconnection(string connectionLuid, byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionitem|errorUpdate analytics extension connection of site
Parameters
- connectionLuid string -
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionitem|error - Successful.
analyticsextensionsserviceDeleteanalyticsextensionsconnection
function analyticsextensionsserviceDeleteanalyticsextensionsconnection(string connectionLuid, string? xTableauAuth) returns Response|errorDelete analytics extension connection from site
Parameters
- connectionLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitem
function dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitem(string safeListItemLuid, string? xTableauAuth) returns TableauExtensionsDashboardV1Safelistitem|errorGet allowed dashboard extension on site
Parameters
- safeListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauExtensionsDashboardV1Safelistitem|error - Successful.
dashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitem
function dashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitem(string safeListItemLuid, byte[] payload, string? xTableauAuth) returns TableauExtensionsDashboardV1Safelistitem|errorUpdate settings for allowed dashboard extension on site
Parameters
- safeListItemLuid string -
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauExtensionsDashboardV1Safelistitem|error - Successful.
dashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitem
function dashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitem(string safeListItemLuid, string? xTableauAuth) returns Response|errorDisallow dashboard extension on site
Parameters
- safeListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
analyticsextensionsserviceGetconnectionoptionsforworkbook
function analyticsextensionsserviceGetconnectionoptionsforworkbook(string workbookLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorList analytics extension connections of workbook
Parameters
- workbookLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceGetselectedconnectionforworkbook
function analyticsextensionsserviceGetselectedconnectionforworkbook(string workbookLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorGet current analytics extension for workbook
Parameters
- workbookLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceUpdateworkbookwithconnection
function analyticsextensionsserviceUpdateworkbookwithconnection(string workbookLuid, byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorUpdate analytics extension for workbook
Parameters
- workbookLuid string -
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceDeleteconnectionfromworkbook
function analyticsextensionsserviceDeleteconnectionfromworkbook(string workbookLuid, string? xTableauAuth) returns Response|errorRemove current analytics extension connection for workbook
Parameters
- workbookLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
analyticsextensionsserviceGetanalyticsextensionssitesettings
function analyticsextensionsserviceGetanalyticsextensionssitesettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorGet enabled state of analytics extensions on site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceUpdateanalyticsextensionssitesettings
function analyticsextensionsserviceUpdateanalyticsextensionssitesettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorUpdate enabled state of analytics extensions on site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceGetdashboardextensionssitesettings
function dashboardextensionssitesettingsserviceGetdashboardextensionssitesettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorList dashboard extension settings of site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettings
function dashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettings(byte[] payload, string? xTableauAuth) returns Response|errorUpdate dashboard extension settings of site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitems
function dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitems(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorList blocked dashboard extensions on server
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitem
function dashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitem(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorBlock dashboard extension on server
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitems
function dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitems(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorLists allowed dashboard extensions on site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitem
function dashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitem(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorAllow dashboard extension on site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceGetanalyticsextensionsconnections
function analyticsextensionsserviceGetanalyticsextensionsconnections(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorList analytics extension connections on site
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceAddanalyticsextensionsconnection
function analyticsextensionsserviceAddanalyticsextensionsconnection(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorAdd analytics extension connection to site
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceGetanalyticsextensionsserversettings
function analyticsextensionsserviceGetanalyticsextensionsserversettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorGet enabled state of analytics extensions on server
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
analyticsextensionsserviceUpdateanalyticsextensionsserversettings
function analyticsextensionsserviceUpdateanalyticsextensionsserversettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorEnable or disable analytics extensions on server
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitem
function dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitem(string blockListItemLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorGet blocked dashboard extension on server
Parameters
- blockListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitem
function dashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitem(string blockListItemLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorUnblock dashboard extension on server
Parameters
- blockListItemLuid string -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceGetdashboardextensionsserversettings
function dashboardextensionsserversettingsserviceGetdashboardextensionsserversettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorList settings for dashboard extensions on server
Parameters
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
dashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings
function dashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|errorUpdate dashboard extensions settings of server
Parameters
- payload byte[] -
- xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type
- TableauAnalyticsextensionsV1Connectionmetadatalist|error - Successful.
Records
tableau: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
tableau: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
tableau: ProxyConfig
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
tableau: TableauAnalyticsextensionsV1Connectionbrief
Fields
- connection_name? string - Required. The title of the connection.
- connection_type? string - Required. The kind of service responding to analytics extension requests. The value can be: TABPY, for a Tableau TabPy server; GENERIC_API for your custom service that complies with the Analytics Extensions API spec; or RSERVE, for an Rserve service; or EINSTEIN_DISCOVERY for your instance of Einstein Discovery.
tableau: TableauAnalyticsextensionsV1Connectionitem
Fields
- connection_luid? string -
- host? string - Required. The location of an external service (TabPy, Rserve, EINSTEIN_DISCOVERY, Generic API, or other) that responds to your analytics extension requests. The case sensitive value must be a URI, IPv4 or IPv6 address that is a maximum of 255 Unicode characters.
Starting in Tableau 2022.1 / Online April 2022, a host address can include path information (
www.example.com/path), where previous versions supported only the root domain name (www.example.com).
- port? int - Required. Integer between 1 and 65535.
- is_auth_enabled? boolean - For Tableau Online: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false.
- username? string - For Tableau Online: A username is always required.
- password? string - For Tableau Online: A password is always required.
- is_ssl_enabled? boolean - For Tableau Online: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false.
- connection_brief? TableauAnalyticsextensionsV1Connectionbrief -
tableau: TableauAnalyticsextensionsV1Connectionlist
Fields
- connectionList? TableauAnalyticsextensionsV1Connectionitem[] -
tableau: TableauAnalyticsextensionsV1Connectionmapping
Fields
- workbook_luid? string -
- connection_luid? string -
tableau: TableauAnalyticsextensionsV1Connectionmetadata
Fields
- connection_luid? string -
- connection_brief? TableauAnalyticsextensionsV1Connectionbrief -
tableau: TableauAnalyticsextensionsV1Connectionmetadatalist
Fields
- connectionMetadataList? TableauAnalyticsextensionsV1Connectionmetadata[] -
tableau: TableauAnalyticsextensionsV1Serversettings
Fields
- enabled? boolean -
tableau: TableauAnalyticsextensionsV1Sitesettings
Fields
- enabled? boolean -
tableau: TableauError
Fields
- httpErrorCode? string -
- message? string -
tableau: TableauExtensionsDashboardV1Blocklistitem
A dashboard extension that is blocked from running on a server.
Fields
- url? string - Location of the dashboard extension to be blocked from a site.
- block_list_item_luid? string -
tableau: TableauExtensionsDashboardV1Blocklistitems
List of dashboard extensions blocked from running on a server.
Fields
- block_list_items? TableauExtensionsDashboardV1Blocklistitem[] -
tableau: TableauExtensionsDashboardV1Safelistitem
A dashboard extension that is allowed to run on a site.
Fields
- safe_list_item_luid? string -
- url? string - Location (URL) of the dashboard extension to be allowed on a site.
- allow_full_data? boolean - When true, the extension has access to underlying data of a workbook. This setting is only effective when the extension is on the site safe list. Default is false.
- prompt_needed? boolean - When true, the user will be prompted to grant an extension access to the underlying data of a workbook. This setting is only effective when the extension is on the site safe list. Default is false.
tableau: TableauExtensionsDashboardV1Safelistitems
List of dashboard extensions allowed to run on a site.
Fields
- safe_list_items? TableauExtensionsDashboardV1Safelistitem[] -
tableau: TableauExtensionsDashboardV1Serversettings
Extension settings of a Tableau server.
Fields
- block_list_items? TableauExtensionsDashboardV1Blocklistitem[] -
- extensions_enabled? boolean - Specifies whether sandboxed extensions are allowed to run on the site.
tableau: TableauExtensionsDashboardV1Sitesettings
Dashboard extension settings of a site.
Fields
- extensions_enabled? boolean - Specifies whether extensions are allowed to run on the site.
- allow_sandboxed? boolean - Specifies whether sandboxed extensions are allowed to run on the site.
- safe_list_items? TableauExtensionsDashboardV1Safelistitem[] -
Import
import ballerinax/tableau;Metadata
Released date: 3 days ago
Version: 1.4.2
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.8.0
GraalVM compatible: Yes
Pull count
Total: 31
Current verison: 0
Weekly downloads
Keywords
Data Visualization
Cost/Freemium
Business Intelligence
Vendor/Tableau
Area/Analytics
Type/Connector
Contributors
Dependencies