Skip to contents

Authentication Methods

Authentication methods for Tableau REST API.

authenticate_PAT()
Authenticate to Tableau Server or Tableau Cloud
authenticate_server()
Authenticate on the Tableau server.

Connected App Methods

Connected app methods for Tableau REST API.

get_server_connected_apps()
Get connected applications from Tableau Server.

Data Sources Methods

Data sources methods for Tableau REST API.

download_datasource()
Download a data source in .tdsx format using Tableau REST API and save it as a file.
download_tableau_data()
Download Tableau view data as Excel
get_server_datasources()
Get datasources from Tableau Server.
update_data_source_now()
Update Data Source Now

Extract and Encryption Methods

Extract and encryption methods for Tableau REST API.

get_server_refresh_tasks()
Get extract refresh tasks from Tableau Server.
run_extract_refresh_task()
Run Extract Refresh Task

Favorites Methods

Favorites methods for Tableau REST API.

get_server_user_favorites()
Get favorites for a user from Tableau Server.

Jobs, Tasks, and Schedules Methods

Jobs, tasks, and schedules methods for Tableau REST API.

get_server_jobs()
Get server jobs from Tableau server.
get_server_schedules()
Get schedules from Tableau server.

Metadata Methods

Metadata methods for Tableau REST API.

get_table_assets()
Get table assets from Tableau Server.

Mobile Settings Methods

Mobile settings methods for Tableau REST API.

get_mobile_security_settings()
Get mobile security settings for the server using Tableau REST API.

Projects Methods

Projects methods for Tableau REST API.

get_server_projects()
Get projects from Tableau server.

Server Methods

Server methods for Tableau REST API.

get_server_info()
Get datasources from Tableau Server.

Users and Groups Methods

Users and groups methods for Tableau REST API.

add_user_to_group()
Add User to Group
add_user_to_site()
Add User to Site
create_group()
Create Group
delete_group()
Delete Group
get_groups_for_user()
Get Groups for a User
get_server_groups()
Get groups from Tableau Server.
get_server_users()
Get users from Tableau server.
get_users_in_group()
Get Users in Group
query_user_on_site()
Query User On Site
remove_user_from_group()
Remove User from Group
remove_user_from_site()
Remove User from Site
update_group()
Update Group
update_user()
Update User

Workbooks and Views Methods

Workbooks and Views Methods methods for Tableau REST API.

add_tags_to_view()
Add tags to a view in Tableau Server.
add_tags_to_workbook()
Add tags to a workbook in Tableau Server.
download_filtered_tableau_image()
Download filtered Tableau views to PNG images from a dataframe.
download_tableau_crosstab_excel()
Download Tableau view crosstab as Excel
download_workbooks_server()
Download workbook from Tableau Server.
download_workbooks_server_pdf()
Download workbook PDF from Tableau Server.
download_workbooks_server_powerpoint()
Download workbook PowerPoint from Tableau Server.
get_server_views()
Get views from Tableau server.
get_server_workbooks()
Get workbooks from Tableau server.
update_workbook_now()
Update Workbook Now

Helperfunctions

Underlying helperfunctions for Tableau REST API.

escape_special_chars()
Escape characters for url
row_to_name()
Concat row to name
row_to_query()
Dataframe row to query
tableau_base_url()
Get the Tableau base URL from the environment variable
tableau_content_url()
Get the Tableau content URL from the environment variable
tableau_password()
Get the Tableau password from the environment variable
tableau_pat_name()
Get the Tableau PAT name from the environment variable
tableau_pat_secret()
Get the Tableau PAT secret from the environment variable
tableau_username()
Get the Tableau username from the environment variable

Local workbook methods

Functions that edit local Tableau Workbooks using XML structure.

adjust_tableau_font_style()
adjust_tableau_font_style
adjust_tableau_size()
adjust_tableau_size
check_dashboard_names()
check_dashboard_names
get_actions()
Get Workbook actions
get_folders()
Get folder structure workbook
get_hierarchy()
Get Workbook drilldown hierarchies
get_nodenames()
Get all nodenames
get_parameter()
Get all parameters in workbook.
get_revision()
Get the revision number
get_server_location()
Get the server location.
get_tableau_data_source()
Get Tableau data source
get_variable_folders()
Get folder names
get_variables()
Get variable names from workbook.
get_workbook_id()
Get workbook ID name.
get_workbook_tabs()
Get workbook tabs
get_workbook_urls()
Get Workbook URLs
make_rootnodes()
make_rootnodes