You can wire the Tableau node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.
Credentials
Connect Tableau under Credentials in the node settings. See Connecting credentials for the general flow. Enter the values manually when creating the credential. Get your credentials here.Operations
Analytics extensions
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Analytics Connection | add_analytics_connection | Add an analytics extension connection to the site. | |
| Delete Analytics Connection | delete_analytics_connection | Delete an analytics extension connection from the site. | |
| Delete Analytics Workbook Connection | delete_analytics_workbook_connection | Remove the current analytics extension connection for a workbook. | |
| Get Analytics Connection | get_analytics_connection | Get analytics extension connection details. | |
| Get Analytics Server Settings | get_analytics_server_settings | Get enabled state of analytics extensions on the server. | |
| Get Analytics Site Settings | get_analytics_site_settings | Get enabled state of analytics extensions on the site. | |
| Get Analytics Workbook Connection | get_analytics_workbook_connection | Get the current analytics extension connection selected for a workbook. | |
| List Analytics Connections | list_analytics_connections | List analytics extension connections on the site. | |
| List Analytics Workbook Connections | list_analytics_workbook_connections | List analytics extension connections available to a workbook. | |
| Update Analytics Connection | update_analytics_connection | Update an analytics extension connection of the site. | |
| Update Analytics Server Settings | update_analytics_server_settings | Enable or disable analytics extensions on the server. | |
| Update Analytics Site Settings | update_analytics_site_settings | Update enabled state of analytics extensions on the site. | |
| Update Analytics Workbook Connection | update_analytics_workbook_connection | Set the analytics extension connection for a workbook. |
Authentication
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Get Current Server Session | get_current_session | Get details of the current server session (user, site, and auth settings). | |
| List Personal Access Tokens | list_pats | List the personal access tokens (PATs) for a user (not available on Tableau Server). | |
| Revoke Personal Access Token | revoke_pat | Revoke a personal access token (PAT) by name for a user (not available on Tableau Server). | |
| Switch Site | switch_site | Switch the authenticated session to another site (not available on Tableau Cloud). |
Collections
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Collection Items | add_collection_items | Add items to a collection. | |
| Batch Update Collections | batch_update_collections | Batch update collections. | |
| Create Collection | create_collection | Create a collection. | |
| Delete Collection | delete_collection | Delete a single collection by its LUID. | |
| Delete Collections | delete_collections | Delete multiple collections by their LUIDs. | |
| Get Collection | get_collection | Get details of a collection. | |
| Query Collection Items | query_collection_items | List items in a collection. | |
| Query Collections | query_collections | List collections on the site. | |
| Remove Collection Items | remove_collection_items | Remove items from a collection. | |
| Reorder Collection Items | reorder_collection_items | Reorder items in a collection. |
Connected app
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Connected App | create_connected_app | Create a connected app (direct trust). | |
| Create Connected App Secret | create_connected_app_secret | Create a new secret for a connected app (direct trust). | |
| Delete Connected App | delete_connected_app | Delete a connected app (direct trust). | |
| Delete Connected App Secret | delete_connected_app_secret | Delete a connected app secret by id. | |
| Delete EAS | delete_eas | Delete a registered external authorization server (EAS). | |
| Get Connected App | get_connected_app | Get a connected app (direct trust) by client id. | |
| Get Connected App Secret | get_connected_app_secret | Get a connected app secret by id. | |
| Get EAS | get_eas | Get a registered external authorization server (EAS) by id. | |
| List Connected Apps | list_connected_apps | List all connected apps (direct trust) on the site. | |
| List EAS | list_eas | List all registered external authorization servers (EAS) on the site. | |
| Register EAS | register_eas | Register an external authorization server (EAS) for connected apps. | |
| Update Connected App | update_connected_app | Update a connected app (direct trust). | |
| Update EAS | update_eas | Update a registered external authorization server (EAS). |
Content exploration
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Batch Get Content Usage | batch_get_content_usage | Get batch content usage statistics for multiple content items. | |
| Get Content Suggestions | get_content_suggestions | Get content suggestions for a search term. | |
| Get Content Usage | get_content_usage | Get usage statistics for a single content item. | |
| Search Content | search_content | Get content search results across the site. |
Custom domain
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Custom Domain Settings | create_custom_domain_settings | Create custom domain settings for the site. | |
| Delete Custom Domain Settings | delete_custom_domain_settings | Delete custom domain settings for the site. | |
| Get Custom Domain Name | get_custom_domain | Get the custom domain name for the site. | |
| Get Custom Domain Settings | get_custom_domain_settings | Get custom domain settings for the site. | |
| Update Custom Domain Settings | update_custom_domain_settings | Update custom domain settings for the site. |
Data sources
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Data Source Permissions | add_datasource_permissions | Add permissions (grantee capabilities) to a data source. | |
| Add Tags to Data Source | add_datasource_tags | Add one or more tags to a data source. | |
| Delete Data Source | delete_datasource | Delete a data source from the site. | |
| Delete Data Source Permission | delete_datasource_permission | Delete a single capability from a user or group on a data source. | |
| Delete Tag from Data Source | delete_datasource_tag | Delete a tag from a data source. | |
| Download Data Source | download_datasource | Download a data source (.tdsx/.tds) content. | |
| Download Data Source Revision | download_datasource_revision | Download the content of a specific data source revision. | |
| Get Data Source | get_datasource | Get details for a single data source. | |
| Get Data Source Revisions | query_datasource_revisions | List the revisions of a data source. | |
| Query Data Source Connections | query_datasource_connections | List the connections of a data source. | |
| Query Data Source Permissions | query_datasource_permissions | List the permissions on a data source. | |
| Query Data Sources | query_datasources | List published data sources on the site. | |
| Refresh Data Source Now | refresh_datasource | Trigger an immediate extract refresh for a data source (returns a job). | |
| Remove Data Source Revision | remove_datasource_revision | Remove a specific revision of a data source. | |
| Retrieve Data Source Keychain | retrieve_datasource_keychain | Retrieve the encrypted keychain of a data source (for migration to another site). | |
| Update Data in Hyper Connection | update_datasource_connection_data | Update data in a specific Hyper connection of a data source. | |
| Update Data in Hyper Data Source | update_datasource_data | Update data in a published Hyper data source via insert/update/delete/replace actions. | |
| Update Data Source | update_datasource | Update a data source’s name, project, owner, or certification. | |
| Update Data Source Connection | update_datasource_connection | Update the server address, port, or credentials of a data source connection. |
Extract and encryption
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Extract for Data Source | create_datasource_extract | Create an extract for a published data source. | |
| Create Extract for Workbook | create_workbook_extract | Create extracts for the embedded data sources in a workbook. | |
| Decrypt Extracts | decrypt_extracts | Decrypt all extracts on the site. | |
| Delete Extract for Data Source | delete_datasource_extract | Delete the extract from a published data source. | |
| Delete Extract for Workbook | delete_workbook_extract | Delete the extracts of the embedded data sources in a workbook. | |
| Encrypt Extracts | encrypt_extracts | Encrypt all extracts on the site. | |
| Reencrypt Extracts | reencrypt_extracts | Reencrypt all extracts on the site with new encryption keys. |
Favorites
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Data Source to Favorites | add_datasource_favorite | Add a data source to a user’s favorites. | |
| Add Flow to Favorites | add_flow_favorite | Add a flow to a user’s favorites. | |
| Add Metric to Favorites | add_metric_favorite | Add a metric to a user’s favorites (retired in API 3.22). | |
| Add Project to Favorites | add_project_favorite | Add a project to a user’s favorites. | |
| Add View to Favorites | add_view_favorite | Add a view to a user’s favorites. | |
| Add Workbook to Favorites | add_workbook_favorite | Add a workbook to a user’s favorites. | |
| Delete Data Source from Favorites | delete_datasource_favorite | Delete a data source from a user’s favorites. | |
| Delete Flow from Favorites | delete_flow_favorite | Delete a flow from a user’s favorites. | |
| Delete Project from Favorites | delete_project_favorite | Delete a project from a user’s favorites. | |
| Delete View from Favorites | delete_view_favorite | Delete a view from a user’s favorites. | |
| Delete Workbook from Favorites | delete_workbook_favorite | Delete a workbook from a user’s favorites. | |
| Get Favorites for User | get_user_favorites | Get the favorites for a user. | |
| Organize Favorites | organize_favorites | Organize/reorder a user’s favorites by moving a favorite after another. |
Flow
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Flow Permissions | add_flow_permissions | Add permissions (capabilities) to a flow for users/groups. | |
| Cancel Flow Run | cancel_flow_run | Cancel an in-progress flow run. | |
| Create Cloud Flow Task | create_flow_task | Create a scheduled (Tableau Cloud) flow task. | |
| Delete Flow | delete_flow | Delete a flow. | |
| Delete Flow Permission | delete_flow_permission | Delete a single flow permission (capability) for a grantee. | |
| Download Flow | download_flow | Download a flow (.tfl / .tflx). | |
| Get Flow | get_flow | Get a single flow by LUID. | |
| Get Flow Run | get_flow_run | Get a single flow run by LUID. | |
| Get Flow Run Task | get_flow_run_task | Get a single scheduled flow-run task by LUID. | |
| Get Flow Run Tasks | get_flow_run_tasks | Get all scheduled flow-run tasks on the site. | |
| Get Flow Runs | get_flow_runs | Get all flow runs on the site. | |
| Get Linked Task | get_linked_task | Get a single linked task by LUID. | |
| Get Linked Tasks | get_linked_tasks | Get all linked tasks on the site. | |
| List Flow Permissions | list_flow_permissions | List a flow’s permissions. | |
| Query Flow Connections | query_flow_connections | List a flow’s connections. | |
| Query Flows | query_flows | Query all flows on the site. | |
| Query Flows For User | query_flows_for_user | Query flows owned by / available to a user. | |
| Run Flow Now | run_flow_now | Run a flow immediately. | |
| Run Flow Task Now | run_flow_task | Run a scheduled flow-run task immediately. | |
| Run Linked Task Now | run_linked_task_now | Run a linked task immediately. | |
| Update Flow | update_flow | Update a flow’s name, description, or project. | |
| Update Flow Connection | update_flow_connection | Update a flow connection. |
Identity pools
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Configure Identity Store | configure_identity_store | Configure (register) an identity store. | |
| Create Authentication Configuration | create_auth_configuration | Create (register) an authentication configuration. | |
| Create Identity Pool | create_identity_pool | Create (register) an identity pool. | |
| Delete Authentication Configuration | delete_auth_configuration | Delete an authentication configuration. | |
| Delete Identity Pool | delete_identity_pool | Delete an identity pool by UUID. | |
| Delete Identity Store | delete_identity_store | Delete an identity store. | |
| Get Identity Pool | get_identity_pool | Get an identity pool by UUID. | |
| List Authentication Configurations | list_auth_configuration | List authentication configurations on the server. | |
| List Identity Pools | list_identity_pool | List identity pools on the server. | |
| List Identity Stores | list_identity_store | List identity stores on the server. | |
| Update Authentication Configuration | update_auth_configuration | Update an authentication configuration. | |
| Update Identity Pool | update_identity_pool | Update an identity pool by UUID. |
Jobs tasks schedules
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Data Source to Schedule | add_datasource_to_schedule | Add a data source to a server extract refresh schedule. | |
| Add Workbook to Schedule | add_workbook_to_schedule | Add a workbook to a server extract refresh schedule. | |
| Cancel Job | cancel_job | Cancel a running or pending background job. | |
| Create Schedule | create_schedule | Create a server-level schedule. | |
| Delete Data Acceleration Task | delete_data_acceleration_task | Delete a data acceleration task. | |
| Delete Schedule | delete_schedule | Delete a server-level schedule. | |
| Get Extract Refresh Task | get_extract_refresh_task | Get information about a single extract refresh task. | |
| Get Job | get_job | Get the status of a background job. | |
| Get Schedule | get_schedule | Get details of a server-level schedule. | |
| Get Schedule Extract Refresh Tasks | get_schedule_extract_refresh_tasks | List the extract refresh tasks associated with a schedule. | |
| List Data Acceleration Tasks | list_data_acceleration_tasks | List data acceleration tasks on the site. | |
| List Extract Refresh Tasks | list_extract_refresh_tasks | List extract refresh tasks on the site. | |
| Query Jobs | query_jobs | List background jobs (extract refreshes, subscriptions, flows, etc.). | |
| Query Schedules | query_schedules | List server-level schedules. | |
| Run Extract Refresh Task Now | run_extract_refresh_task | Run an extract refresh task immediately (run now). | |
| Update Schedule | update_schedule | Update a server-level schedule. |
Metadata
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Column Tags | add_column_tags | Add one or more tags to a column asset. | |
| Add Data Quality Warning | add_data_quality_warning | Add a data quality warning to a content asset. | |
| Add Database Tags | add_database_tags | Add one or more tags to a database asset. | |
| Add Table Tags | add_table_tags | Add one or more tags to a table asset. | |
| Add Virtual Connection Tags | add_virtualconnection_tags | Add one or more tags to a virtual connection asset. | |
| Batch Add Tags | batch_add_tags | Batch add tags to a list of content assets. | |
| Batch Delete Data Quality Warnings | batch_delete_data_quality_warning | Batch delete data quality warnings on a list of content. | |
| Batch Delete Tags | batch_delete_tags | Batch delete tags from a list of content assets. | |
| Batch Update Data Quality Warnings | batch_update_data_quality_warning | Batch add or update data quality warnings on a list of content. | |
| Create Label Category | create_label_category | Create a label category on the site. | |
| Create Or Update Label Value | create_or_update_label_value | Create or update a label value on the site. | |
| Delete Column | delete_column | Remove a column asset from the metadata store. | |
| Delete Column Tag | delete_column_tag | Delete a tag from a column asset. | |
| Delete Data Quality Warning | delete_data_quality_warning | Delete a data quality warning by its LUID. | |
| Delete Data Quality Warning By Content | delete_data_quality_warning_by_content | Delete the data quality warning(s) on a content asset. | |
| Delete Database | delete_database | Remove a database asset from the metadata store. | |
| Delete Database Tag | delete_database_tag | Delete a tag from a database asset. | |
| Delete Label | delete_label | Delete a label by its LUID. | |
| Delete Labels | delete_labels | Delete labels on a list of content. | |
| Delete Table | delete_table | Remove a table asset from the metadata store. | |
| Delete Table Tag | delete_table_tag | Delete a tag from a table asset. | |
| Get Column | get_column | Get information about a column in a table. | |
| Get Data Quality Warning | get_data_quality_warning | Get a data quality warning by its LUID. | |
| Get Data Quality Warning By Content | get_data_quality_warning_by_content | Get the data quality warning(s) on a content asset. | |
| Get Database | get_database | Get information about a database asset. | |
| Get Label | get_label | Get a label by its LUID. | |
| Get Table | get_table | Get information about a table asset. | |
| Query Columns | query_columns | Query columns in a table known to the metadata store. | |
| Query Databases | query_databases | Query databases known to the metadata store on the site. | |
| Query Tables | query_tables | Query tables known to the metadata store on the site. | |
| Update Column | update_column | Update the description of a column in a table. | |
| Update Data Quality Warning | update_data_quality_warning | Update a data quality warning by its LUID. | |
| Update Database | update_database | Update metadata (description, certification, contact) of a database. | |
| Update Table | update_table | Update metadata (description, certification, contact) of a table. |
Notifications
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add User to Data-Driven Alert | add_data_alert_user | Add a user as a recipient of a data-driven alert. | |
| Create Data-Driven Alert | create_data_alert | Create a data-driven alert on a view/worksheet. | |
| Delete Data-Driven Alert | delete_data_alert | Delete a data-driven alert. | |
| Delete User from Data-Driven Alert | delete_data_alert_user | Remove a user as a recipient of a data-driven alert. | |
| Get Data-Driven Alert | get_data_alert | Get a single data-driven alert. | |
| Get Notification Preferences | get_notification_preferences | Get user notification preferences for the site. | |
| Get Webhook | get_webhook | Get information about a webhook. | |
| Query Data-Driven Alerts | query_data_alerts | List data-driven alerts on the site. | |
| Update Data-Driven Alert | update_data_alert | Update a data-driven alert. | |
| Update Notification Preferences | update_notification_preferences | Update user notification preferences for the site. | |
| Update Webhook | update_webhook | Update an existing webhook. |
Projects
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Project | create_project | Create a new project on the site. | |
| Create Project With Samples | create_project_with_samples | Create a project and optionally publish Tableau sample content into it. | |
| Delete Project | delete_project | Delete a project and all of its contents. | |
| Query Projects | query_projects | List projects (folders) on the site. | |
| Update Project | update_project | Update a project’s name, description, owner, or permissions. |
Publishing
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Append to File Upload | append_file_upload | Append a chunk to an existing file upload session. | |
| Initiate File Upload | initiate_file_upload | Initiate a chunked file upload session; returns an uploadSessionId. |
Pulse
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Batch Create Pulse Subscriptions | batch_create_pulse_subscriptions | Batch create Pulse subscriptions. | |
| Batch Get Metric Definitions | batch_get_metric_definitions | Batch get a small number of Pulse metric definitions (GET). | |
| Batch Get Metric Definitions (POST) | batch_get_metric_definitions_by_post | Batch get many Pulse metric definitions (POST). | |
| Batch Get Metric Follower Counts | batch_get_metric_follower_counts | Batch get Pulse metric follower (subscriber) counts. | |
| Batch Get Pulse Metrics | batch_get_pulse_metrics | Batch get a small number of Pulse metrics (GET). | |
| Batch Get Pulse Metrics (POST) | batch_get_pulse_metrics_by_post | Batch get many Pulse metrics (POST). | |
| Batch Get Pulse Subscriptions | batch_get_pulse_subscriptions | Batch get Pulse subscriptions. | |
| Create Metric Definition | create_metric_definition | Create a Pulse metric definition. | |
| Create Metric Tag | create_metric_tag | Create a Pulse metric tag for the current user. | |
| Create Pulse Metric | create_pulse_metric | Create a Pulse metric. | |
| Create Pulse Subscription | create_pulse_subscription | Create a Pulse subscription. | |
| Delete Metric Definition | delete_metric_definition | Delete a Pulse metric definition. | |
| Delete Metric Tag | delete_metric_tag | Delete a Pulse metric tag. | |
| Delete Pulse Metric | delete_pulse_metric | Delete a Pulse metric. | |
| Delete Pulse Subscription | delete_pulse_subscription | Delete a Pulse subscription. | |
| Generate Insight Brief | generate_insight_brief | Generate an insight brief. | |
| Generate Insight Bundle (BAN) | generate_insight_ban | Generate the current-metric-value (BAN) insight bundle. | |
| Generate Insight Bundle (Basic) | generate_insight_basic | Generate the basic insight bundle. | |
| Generate Insight Bundle (Breakdown) | generate_insight_breakdown | Generate the breakdown insight bundle. | |
| Generate Insight Bundle (Detail) | generate_insight_detail | Generate the detail insight bundle. | |
| Generate Insight Bundle (Exploration) | generate_insight_exploration | Generate the exploration insight bundle. | |
| Generate Insight Bundle (Springboard) | generate_insight_springboard | Generate the springboard insight bundle. | |
| Generate Metric Card Image | generate_metric_card_image | Generate a Pulse metric card image. | |
| Get Measurement Periods | get_measurement_periods | List a Pulse metric definition’s measurement periods. | |
| Get Metric Definition | get_metric_definition | Get a Pulse metric definition. | |
| Get or Create Pulse Metric | get_or_create_pulse_metric | Get or create a Pulse metric. | |
| Get Pulse Entitlements | get_pulse_entitlements | Get Pulse site entitlements. | |
| Get Pulse Metric | get_pulse_metric | Get a Pulse metric. | |
| Get Pulse Subscription | get_pulse_subscription | Get a Pulse subscription. | |
| Get Pulse User Preferences | get_pulse_user_preferences | List Pulse user preferences for the current user. | |
| Get Recommended Metrics | get_recommended_metrics | Get recommended Pulse metrics. | |
| List Definition Metrics | list_definition_metrics | List the metrics belonging to a Pulse metric definition. | |
| List Followed Metrics Groups | list_followed_metrics_groups | List followed Pulse metrics groups for the current user. | |
| List Metric Definitions | list_metric_definitions | List Pulse metric definitions. | |
| List Pulse Alerts | list_pulse_alerts | List Pulse alerts on the site. | |
| List Pulse Subscriptions | list_pulse_subscriptions | List Pulse subscriptions. | |
| Update Metric Definition | update_metric_definition | Update a Pulse metric definition. | |
| Update Pulse Metric | update_pulse_metric | Update a Pulse metric. | |
| Update Pulse User Preferences | update_pulse_user_preferences | Update Pulse user preferences for the current user. |
Server
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Delete Session | delete_session | Delete a server session by its ID. | |
| Get Server Info | get_server_info | Get server info + supported REST API version. | |
| List Active Directory Domains | list_ad_domains | List the Active Directory domains in use on the server. | |
| Update Active Directory Domain | update_ad_domain | Update the nickname (short name) of an Active Directory domain. |
Sites
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Site | create_site | Create a new site (server admin only). | |
| Delete Site | delete_site | Delete the specified site (server admin only). | |
| Get Data Acceleration Report for Site | get_data_acceleration_report | Get the data acceleration report for the site. | |
| Get Embedding Settings for Site | get_site_embedding_settings | Get the embedding settings for the site. | |
| Get Recently Viewed for Site | get_recently_viewed | Get the content recently viewed by the signed-in user on the site. | |
| Get User Personal Space | get_user_personal_space | Get information about the personal space of the signed-in user on the site. | |
| List Authentication Configurations for Site | list_site_auth_configurations | List the authentication configurations for the site. | |
| Query Site | query_site | Query information about the specified site. | |
| Query Sites | query_sites | List all sites on the server (server admin only). | |
| Query Views for Site | query_site_views | List all views in the site, optionally with usage statistics. | |
| Update Embedding Settings for Site | update_site_embedding_settings | Update the embedding settings for the site. | |
| Update Site | update_site | Update settings for the specified site (server admin only). |
Subscriptions
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Subscription | create_subscription | Create a subscription to a view or workbook for a user on a schedule. | |
| Delete Subscription | delete_subscription | Delete a subscription. | |
| Get Subscription | get_subscription | Get details of a single subscription. | |
| Query Subscriptions | query_subscriptions | List the subscriptions on the site. | |
| Update Subscription | update_subscription | Update a subscription’s subject, schedule, or delivery options. |
Users & groups
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add User to Group | add_user_to_group | Add a user to a group. | |
| Add User to Site | add_user | Provision a user on the site with a site role. | |
| Get Users on Site | get_users | List users on the site. | |
| Query Groups | query_groups | List groups on the site. |
Users and groups
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Group to Group Set | add_group_to_group_set | Add a group to a group set. | |
| Create Group | create_group | Create a local group (or import an Active Directory group). | |
| Create Group Set | create_group_set | Create a group set. | |
| Delete Group | delete_group | Delete a group from the site. | |
| Delete Group Set | delete_group_set | Delete a group set. | |
| Delete Users from CSV | delete_users_csv | Delete users from the site using a CSV payload. | |
| Get Group Set | get_group_set | Get a single group set by LUID. | |
| Get Groups for a User | get_groups_for_user | List the groups a user belongs to. | |
| Get Groups in Group Set | get_groups_in_group_set | List the groups that belong to a group set. | |
| Get Users in Group | get_users_in_group | List the users that belong to a group. | |
| Import Users from CSV | import_users_csv | Import users to the site from a CSV payload. | |
| Query Group Sets | query_group_sets | List group sets on the site. | |
| Remove Group from Group Set | remove_group_from_group_set | Remove a group from a group set. | |
| Remove User from Group | remove_user_from_group | Remove a user from a group. | |
| Remove User from Site | remove_user | Remove a user from the site. | |
| Update Group | update_group | Update a group’s name or import settings. | |
| Update Group Set | update_group_set | Update a group set’s properties. | |
| Update User | update_user | Update a user’s full name, email, site role, or auth setting. |
Views
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Tags to View | add_view_tags | Add one or more tags to a view. | |
| Delete Custom View | delete_custom_view | Delete a custom view from the site. | |
| Delete Tag from View | delete_view_tag | Delete a tag from a view. | |
| Delete View | delete_view | Delete a view from the site. | |
| Download View Crosstab (Excel) | download_view_crosstab | Download a view’s crosstab data as an Excel (.xlsx) file. | |
| Get Custom View | get_custom_view | Get details of a specific custom view. | |
| Get Custom View Data (CSV) | get_custom_view_data | Download the underlying data (CSV) of a custom view. | |
| Get Custom View Image | get_custom_view_image | Download an image (PNG) of a custom view. | |
| Get Custom View PDF | get_custom_view_pdf | Download a PDF of a custom view. | |
| Get View | get_view | Get details of a specific view. | |
| Get View by Path | get_view_by_path | Get a view by its URL name via a filter expression. | |
| Get View Recommendations | get_view_recommendations | Get view recommendations for the current user (deprecated in API 3.19). | |
| List Custom Views | list_custom_views | List custom views on the site. | |
| Query View Data (CSV) | query_view_data | Export the underlying view data as CSV. | |
| Query View Image | query_view_image | Render a view as a PNG image. | |
| Query View PDF | query_view_pdf | Render a view as a PDF document. | |
| Query Views | query_views | List all views on the site. | |
| Update Custom View | update_custom_view | Update a custom view’s name or owner. |
Virtual connections
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Virtual Connection Permissions | add_virtual_connection_permissions | Add permissions to a virtual connection. | |
| Add Virtual Connection Tags | add_virtual_connection_tags | Add tags to a virtual connection. | |
| Delete Virtual Connection | delete_virtual_connection | Delete a virtual connection. | |
| Delete Virtual Connection Permission | delete_virtual_connection_permission | Delete a single permission from a virtual connection. | |
| Delete Virtual Connection Tag | delete_virtual_connection_tag | Delete a tag from a virtual connection. | |
| Download Virtual Connection Revision | download_virtual_connection_revision | Download a specific revision of a virtual connection. | |
| Get Virtual Connection | get_virtual_connection | Get (download) a virtual connection’s definition. | |
| List Virtual Connection DB Connections | list_virtual_connection_connections | List the database connections of a virtual connection. | |
| List Virtual Connection Permissions | list_virtual_connection_permissions | List permissions on a virtual connection. | |
| List Virtual Connection Revisions | list_virtual_connection_revisions | List revisions of a virtual connection. | |
| List Virtual Connections | list_virtual_connections | List virtual connections on the site. | |
| Publish Virtual Connection | publish_virtual_connection | Publish a virtual connection. | |
| Update Virtual Connection | update_virtual_connection | Update a virtual connection’s metadata. | |
| Update Virtual Connection DB Connection | update_virtual_connection_connection | Update a database connection of a virtual connection. |
Webhooks
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Webhook | create_webhook | Subscribe an HTTPS URL to a single Tableau trigger event. | |
| Delete Webhook | delete_webhook | Remove a webhook subscription. | |
| List Webhooks | list_webhooks | List configured webhooks on the site. | |
| Test Webhook | test_webhook | Send a test POST to validate a webhook. |
Workbooks
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Tags to Workbook | add_workbook_tags | Add one or more tags to a workbook. | |
| Add Workbook Permissions | add_workbook_permissions | Add permissions (grantee capabilities) to a workbook. | |
| Delete Tag from Workbook | delete_workbook_tag | Delete a tag from a workbook. | |
| Delete Workbook | delete_workbook | Delete a workbook from the site. | |
| Delete Workbook Permission | delete_workbook_permission | Delete a specific capability granted to a user or group on a workbook. | |
| Download Workbook | download_workbook | Download a workbook’s content (.twb or .twbx). | |
| Download Workbook PDF | download_workbook_pdf | Download a PDF of all views in a workbook. | |
| Download Workbook PowerPoint | download_workbook_powerpoint | Download a PowerPoint (.pptx) of the views in a workbook. | |
| Download Workbook Revision | download_workbook_revision | Download a specific revision of a workbook’s content. | |
| Get Workbook | get_workbook | Get details for a single workbook. | |
| Get Workbook Downgrade Info | get_workbook_downgrade_info | Get info on features that would be lost downgrading a workbook to an older version. | |
| Get Workbook Revisions | get_workbook_revisions | List the revision history for a workbook. | |
| Query Views for Workbook | query_views_for_workbook | List the views contained in a workbook. | |
| Query Workbook Connections | query_workbook_connections | List the data connections in a workbook. | |
| Query Workbook Permissions | query_workbook_permissions | List the permissions set on a workbook. | |
| Query Workbooks | query_workbooks | List workbooks on the site (supports filter / sort / paging). | |
| Refresh Workbook Now | refresh_workbook | Trigger an immediate extract refresh for a workbook (returns a job). | |
| Remove Workbook Revision | remove_workbook_revision | Remove a specific revision of a workbook. | |
| Retrieve Workbook Keychain | retrieve_workbook_keychain | Retrieve the encrypted keychain of a workbook (for cross-site/server copy). | |
| Update Workbook | update_workbook | Update a workbook’s settings (name, description, project, owner, showTabs). | |
| Update Workbook Connection | update_workbook_connection | Update the server address, port, or credentials of a workbook connection. |
Other
| Operation | ID | Description | Trigger |
|---|---|---|---|
| On Admin Demoted | on_admin_demoted | Yes | |
| On Admin Promoted | on_admin_promoted | Yes | |
| On Data Source Created | on_datasource_created | Yes | |
| On Data Source Deleted | on_datasource_deleted | Yes | |
| On Data Source Refresh Failed | on_datasource_refresh_failed | Yes | |
| On Data Source Refresh Started | on_datasource_refresh_started | Yes | |
| On Data Source Refresh Succeeded | on_datasource_refresh_succeeded | Yes | |
| On Data Source Updated | on_datasource_updated | Yes | |
| On Label Created | on_label_created | Yes | |
| On Label Deleted | on_label_deleted | Yes | |
| On Label Updated | on_label_updated | Yes | |
| On Site Deleted | on_site_deleted | Yes | |
| On User Deleted | on_user_deleted | Yes | |
| On View Deleted | on_view_deleted | Yes | |
| On Workbook Created | on_workbook_created | Yes | |
| On Workbook Deleted | on_workbook_deleted | Yes | |
| On Workbook Refresh Failed | on_workbook_refresh_failed | Yes | |
| On Workbook Refresh Started | on_workbook_refresh_started | Yes | |
| On Workbook Refresh Succeeded | on_workbook_refresh_succeeded | Yes | |
| On Workbook Updated | on_workbook_updated | Yes |