| Type: | Package |
| Title: | R Interface for 'Tableau' Services |
| Version: | 0.7.0 |
| Description: | Provides an R interface for interacting with the 'Tableau' Server. It allows users to perform various operations such as publishing workbooks, refreshing data extracts, and managing users using the 'Tableau' REST API (see https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm for details). Additionally, it includes functions to perform manipulations on local 'Tableau' workbooks. |
| URL: | https://github.com/vusaverse/vvtableau, https://vusaverse.github.io/vvtableau/ |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.2 |
| Imports: | data.table, dplyr, httr, jsonlite, magrittr, purrr, stringr, tidyr, XML, xml2 |
| Suggests: | knitr, rmarkdown |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2024-08-29 06:33:43 UTC; tin900 |
| Author: | Tomer Iwan [aut, cre], Ruben Korvinus [ctb], Jorn Amatdoelrasit [ctb], VU Analytics [cph] |
| Maintainer: | Tomer Iwan <t.iwan@vu.nl> |
| Repository: | CRAN |
| Date/Publication: | 2024-08-29 07:00:02 UTC |
Pipe operator
Description
See magrittr::%>% for details.
Usage
lhs %>% rhs
Arguments
lhs |
A value or the magrittr placeholder. |
rhs |
A function call using the magrittr semantics. |
Value
The result of calling 'rhs(lhs)'.
Add tags to a view in Tableau Server.
Description
Adds one or more tags to the specified view in the Tableau Server using the provided authentication credentials.
Usage
add_tags_to_view(tableau, api_version = 3.8, view_id, tags)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.8). |
view_id |
The ID of the view to add tags to. |
tags |
A vector of tags to add to the view. |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Add tags to a workbook in Tableau Server.
Description
Adds one or more tags to the specified workbook in the Tableau Server using the provided authentication credentials.
Usage
add_tags_to_workbook(tableau, api_version = 3.8, workbook_id, tags)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.8). |
workbook_id |
The ID of the workbook to add tags to. |
tags |
A vector of tags to add to the workbook. |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Add User to Group
Description
Adds a user to the specified group.
Usage
add_user_to_group(tableau, api_version = 3.19, group_id, user_id)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The version of the API to use, such as 3.19 (default: 3.19). |
group_id |
The ID of the group to add the user to. |
user_id |
The ID (not name) of the user to add. You can get the user ID by calling Get Users on Site. |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Add User to Site
Description
Adds a user to Tableau Server or Tableau and assigns the user to the specified site.
Usage
add_user_to_site(
tableau,
site_role,
user_name,
auth_setting = NULL,
api_version = 3.19
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
site_role |
The site role to assign to the user. |
user_name |
The name of the user to add. |
auth_setting |
The authentication type for the user. |
api_version |
The API version to use (default: 3.19). |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
adjust_tableau_font_style
Description
Adjust the font style of a tableau file
Usage
adjust_tableau_font_style(
import_files,
font_style = "Tableau Regular",
save_location = NULL
)
Arguments
import_files |
selected tableau file or folder, to change its font style. If it is only a file, make sure it is a twb file. |
font_style |
the name of the font style you want to use (in quotation marks "") |
save_location |
The location to which the adjusted tableau file will be saved (this needs to be a .twb file). If empty, the adjusted tableau file will be overwritten. |
Value
tableau file with the correct font style.
adjust_tableau_size
Description
Adjust the size of selected tableau file/files.
Usage
adjust_tableau_size(
import_files,
save_location = NULL,
maxheight = NULL,
maxwidth = NULL,
minheight = NULL,
minwidth = NULL
)
Arguments
import_files |
selected tableau file or folder, to change its size. If it is only one file, make sure it is a twb file. |
save_location |
The location to which the adjusted tableau file will be saved (this needs to be a .twb file). If empty, the adjusted tableau file will be overwritten. |
maxheight |
Max height for tableau file, if NULL use system variables. |
maxwidth |
Max width for tableau file, if NULL use system variables. |
minheight |
Min height for tableau file, if NULL use system variables. |
minwidth |
Min width for tableau file, if NULL use system variables. |
Value
tableau file with the correct size.
See Also
Other xml:
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Authenticate to Tableau Server or Tableau Cloud
Description
This function authenticates to a Tableau Server or Tableau Cloud using a personal access token (PAT).
Usage
authenticate_PAT(
pat_name = tableau_pat_name(),
pat_secret = tableau_pat_secret(),
content_url = tableau_content_url(),
base_url = tableau_base_url(),
api_version = 3.4
)
Arguments
pat_name |
The name of the personal access token (PAT). Defaults to the 'TABLEAU_PAT_NAME' environment variable. |
pat_secret |
The secret of the personal access token (PAT). Defaults to the 'TABLEAU_PAT_SECRET' environment variable. |
content_url |
The URL of the content to authenticate. Defaults to the 'TABLEAU_CONTENT_URL' environment variable. For Tableau Server, this is typically the URL of the Tableau server followed by the site ID. For Tableau Cloud, this is usually the URL of the Tableau cloud workbook. |
base_url |
The base URL of the Tableau server or Tableau cloud. Defaults to the 'TABLEAU_BASE_URL' environment variable. For Tableau Server, this is usually the URL of the Tableau server. For Tableau Cloud, this is usually the URL of the Tableau cloud, and it must contain the pod name, such as 10az, 10ay, or us-east-1. For example, the base URL to sign in to a site in the 10ay pod would be: https://10ay.online.tableau.com. |
api_version |
The API version to use. Default is 3.4. |
Value
A list containing the base URL, the access token, the site ID, and the user ID.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Authenticate on the Tableau server.
Description
Authenticates the user on the Tableau server and retrieves the necessary authentication variables for running other Tableau REST API methods.
Usage
authenticate_server(
username = tableau_username(),
password = tableau_password(),
base_url = tableau_base_url(),
api_version = 3.4
)
Arguments
username |
The username on the Tableau server. Defaults to the 'TABLEAU_USERNAME' environment variable. |
password |
The password on the Tableau server. Defaults to the 'TABLEAU_PASSWORD' environment variable. |
base_url |
The base URL of the Tableau server. Defaults to the 'TABLEAU_BASE_URL' environment variable. |
api_version |
The API version to use (default: 3.4). |
Value
A list containing the authentication variables: base_url, token, site_id, and user_id.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
check_dashboard_names
Description
Check the names of dashboards in tableau, according to the style guide. The wrong dashboards will be returned together with the reason why it is a wrong name
Usage
check_dashboard_names(import_files)
Arguments
import_files |
selected tableau file or folder, to check the names of the dashboards. If it is only one file, make sure it is a twb file. |
Value
the wrongly named dashboards
See Also
Other xml:
adjust_tableau_size(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Create Group
Description
Creates a group on Tableau Server or Tableau Cloud site.
Usage
create_group(tableau, group_name, api_version = 3.19)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
group_name |
The name of the group to create. |
api_version |
The API version to use (default: 3.19). |
Value
The ID of the new group.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Delete Group
Description
Deletes the specified group from the site.
Usage
delete_group(tableau, group_id, api_version = 3.19)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
group_id |
The ID of the group to delete. |
api_version |
The API version to use (default: 3.19). |
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Download a data source in .tdsx format using Tableau REST API and save it as a file.
Description
Downloads a data source in .tdsx format and saves it as a file on your computer.
Usage
download_datasource(
tableau,
api_version = 3.16,
datasource_id,
file_path,
include_extract = TRUE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.16). |
datasource_id |
The ID of the data source to download. |
file_path |
The path to save the downloaded data source. |
include_extract |
Logical indicating whether to include the extract when downloading the data source (default: TRUE). |
Value
A binary vector containing the data source in .tdsx format.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Download filtered Tableau views to PNG images from a dataframe.
Description
Downloads PNG images of filtered Tableau views based on the provided dataframe containing filter columns and filter values.
Usage
download_filtered_tableau_image(
tableau,
df,
view_id,
path_to_save,
api_version = 3.8
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
df |
Dataframe containing filter columns and filter values. |
view_id |
The ID of the view to download. |
path_to_save |
The directory to write the images to. |
api_version |
The API version to use (default: 3.8). |
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Download Tableau view crosstab as Excel
Description
Downloads the crosstab data from a Tableau view in Excel format.
Usage
download_tableau_crosstab_excel(
tableau,
view_id,
path_to_save,
api_version = 3.16
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
view_id |
The ID of the view to download. |
path_to_save |
The directory to write the crosstab Excel file to. |
api_version |
The API version to use (default: 3.16). |
Note
If a crosstab is exported from a dashboard, data from only the first view in the dashboard will appear in the .xlsx file. Downloads of data from story dashboards are not supported at this time.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Download Tableau view data as Excel
Description
Downloads the data from a Tableau view in Excel format.
Usage
download_tableau_data(
tableau,
view_id,
path_to_save,
api_version = 3.8,
filters = NULL,
max_age = NULL
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
view_id |
The ID of the view to download. |
path_to_save |
The directory to write the data Excel file to. |
api_version |
The API version to use (default: 3.8). |
filters |
A named list of filters to apply to the view data. The names should be the field names, and the values should be the filter values. |
max_age |
The maximum number of minutes view data will be cached before being refreshed (optional). |
Details
This function uses the Tableau REST API to download data from a specified view in Excel format. It constructs the appropriate URL, applies any specified filters, and saves the data to the specified path.
For more information on the Tableau REST API, see the official documentation for this method: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Examples
## Not run:
tableau <- list(
base_url = "https://your-tableau-server.com/",
token = "your-auth-token",
user_id = "your-user-id",
site_id = "your-site-id"
)
view_id <- "your-view-id"
path_to_save <- "path/to/save/"
filters <- list("Region" = "North America", "Category" = "Technology")
max_age <- 10
download_tableau_data(tableau, view_id, path_to_save, filters = filters, max_age = max_age)
## End(Not run)
Download workbook from Tableau Server.
Description
Downloads a workbook from the Tableau Server using the provided authentication credentials and saves it to the specified path.
Usage
download_workbooks_server(
tableau,
api_version = 3.4,
workbook_id,
path_to_save,
include_extract = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
workbook_id |
The identifier of the workbook to download. |
path_to_save |
The file path to save the downloaded workbook. |
include_extract |
Logical indicating whether to include the extract file (default: FALSE). |
Value
NULL.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Download workbook PDF from Tableau Server.
Description
Downloads a PDF version of a workbook from the Tableau Server using the provided authentication credentials and saves it to the specified path.
Usage
download_workbooks_server_pdf(
tableau,
api_version = 3.4,
workbook_id,
path_to_save
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
workbook_id |
The identifier of the workbook to download. |
path_to_save |
The file path to save the downloaded PDF file. |
Value
NULL.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Download workbook PowerPoint from Tableau Server.
Description
Downloads a PowerPoint version of a workbook from the Tableau Server using the provided authentication credentials and saves it to the specified path.
Usage
download_workbooks_server_powerpoint(
tableau,
api_version = 3.8,
workbook_id,
path_to_save
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.8). |
workbook_id |
The identifier of the workbook to download. |
path_to_save |
The file path to save the downloaded PowerPoint file. |
Value
NULL.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Escape characters for url
Description
Escape characters for url
Usage
escape_special_chars(url)
Arguments
url |
the url |
Value
escaped string
Get Workbook actions
Description
Get Workbook actions
Usage
get_actions(wb)
Arguments
wb |
The path to the Tableau workbook [.twb]. |
Value
Dataframe containing the workbook actions.
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Examples
## Not run:
# Get Workbook actions
actions <- get_actions(wb = "path/to/workbook.twb")
head(actions)
## End(Not run)
Get folder structure workbook
Description
Get folder structure workbook
Usage
get_folders(wb)
Arguments
wb |
The path to the Tableau workbook file [.twb]. |
Value
A dataframe containing the folder names and the variables stored inside.
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get Groups for a User
Description
Gets a list of groups that the specified user is a member of.
Usage
get_groups_for_user(
tableau,
api_version = 3.19,
user_id,
page_size = 100,
page_number = 1,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.19). |
user_id |
The ID of the user whose group memberships are listed. |
page_size |
(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results. |
page_number |
(Optional) The offset for paging. The default is 1. For more information, see Paginating Results. |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A table containing the groups for the specified user.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get Workbook drilldown hierarchies
Description
Get Workbook drilldown hierarchies
Usage
get_hierarchy(wb)
Arguments
wb |
The path to the Tableau workbook [.twb]. |
Value
Dataframe containing the workbook hierarchy drill downs.
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get mobile security settings for the server using Tableau REST API.
Description
Retrieves the mobile security settings for the Tableau Server.
Usage
get_mobile_security_settings(tableau, api_version = 3.19)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id'. |
api_version |
The API version to use (default: 3.19). |
Value
A list containing the mobile security settings for the server.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get all nodenames
Description
Get all nodenames
Usage
get_nodenames(proc)
Arguments
proc |
The rootnode |
Value
nodenames
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get all parameters in workbook.
Description
Get all parameters in workbook.
Usage
get_parameter(wb)
Arguments
wb |
The path to the tableau workbook [.twb]. |
Value
Dataframe
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get the revision number
Description
Get the revision number
Usage
get_revision(wb)
Arguments
wb |
The path to the Tableau workbook file [.twb]. |
Value
The revision number
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get connected applications from Tableau Server.
Description
Retrieves information about connected applications from the Tableau Server using the provided authentication credentials.
Usage
get_server_connected_apps(tableau, api_version = 3.14, page_size = 100)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.14). |
page_size |
The number of records to retrieve per page (default: 100). |
Value
A data frame containing the connected applications information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get datasources from Tableau Server.
Description
Retrieves information about datasources from the Tableau Server using the provided authentication credentials.
Usage
get_server_datasources(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of records to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the datasource information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get groups from Tableau Server.
Description
Retrieves a list of groups from the Tableau Server using the provided authentication credentials.
Usage
get_server_groups(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of records to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the groups information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get datasources from Tableau Server.
Description
Retrieves information about the Tableau server site using the provided authentication credentials.
Usage
get_server_info(
tableau,
api_version = 3.4,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_size |
The number of records to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the server site information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get server jobs from Tableau server.
Description
Retrieves a list of server jobs from the Tableau server using the provided authentication credentials.
Usage
get_server_jobs(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: base_url, token, user_id, and site_id. |
api_version |
The API version to use (default: "3.4"). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of jobs to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the server jobs information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get the server location.
Description
Get the server location.
Usage
get_server_location(wb)
Arguments
wb |
The path to the Tableau workbook [.twb]. |
Value
The server location of the workbook.
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get projects from Tableau server.
Description
Retrieves a list of projects from the Tableau server using the provided authentication credentials.
Usage
get_server_projects(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: base_url, token, site_id, and user_id. |
api_version |
The API version to use (default: "3.4"). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of projects to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the projects information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get extract refresh tasks from Tableau Server.
Description
Retrieves a list of extract refresh tasks from the Tableau Server using the provided authentication credentials.
Usage
get_server_refresh_tasks(tableau, api_version = 3.4, page_size = 100)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_size |
The number of records to retrieve per page (default: 100). |
Value
A data frame containing the extract refresh tasks information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get schedules from Tableau server.
Description
Retrieves a list of schedules from the Tableau server using the provided authentication credentials.
Usage
get_server_schedules(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url' and 'token'. |
api_version |
The API version to use (default: 3.4). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of records to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the schedules information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get favorites for a user from Tableau Server.
Description
Retrieves a list of favorite projects, data sources, views, workbooks, and flows for a specific user on Tableau Server.
Usage
get_server_user_favorites(
tableau,
user_id,
api_version = 3.4,
page_size = 100,
page_number = 1
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
user_id |
The ID of the user for which you want to retrieve the favorites. |
api_version |
The API version to use (default: 3.4). |
page_size |
The number of items to return in one response (default: 100). |
page_number |
The offset for paging (default: 1). |
Value
A data frame containing the favorites for the specified user.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get users from Tableau server.
Description
Retrieves a list of users from the Tableau server using the provided authentication credentials.
Usage
get_server_users(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of users to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the users information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get views from Tableau server.
Description
Retrieves a list of views from the Tableau server using the provided authentication credentials.
Usage
get_server_views(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_statistics = TRUE,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of views to retrieve per page (default: 100). |
include_statistics |
Logical indicating whether to include usage statistics in the result (default: TRUE). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the views information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get workbooks from Tableau server.
Description
Retrieves a list of workbooks from the Tableau server using the provided authentication credentials.
Usage
get_server_workbooks(
tableau,
api_version = 3.4,
page_number = 1,
page_size = 100,
include_metadata = FALSE
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.4). |
page_number |
The page number of the results to retrieve (default: 1). |
page_size |
The number of workbooks to retrieve per page (default: 100). |
include_metadata |
Logical indicating whether to include metadata columns in the result (default: FALSE). |
Value
A data frame containing the workbooks information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get table assets from Tableau Server.
Description
Retrieves information about all table assets for a site from the Tableau Server using the provided authentication credentials.
Usage
get_table_assets(tableau, api_version = 3.8)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The API version to use (default: 3.8). |
Value
A data frame containing the table assets information.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get Tableau data source
Description
Search XML for data source of Tableau workbook
Usage
get_tableau_data_source(dashboard)
Arguments
dashboard |
Path to Tableau twb file. |
Value
Data source of the workbook
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Examples
## Not run:
# Get Tableau data source
data_source <- get_tableau_data_source(dashboard = "path/to/workbook.twb")
print(data_source)
## End(Not run)
Get Users in Group
Description
Gets a list of users in the specified group.
Usage
get_users_in_group(
tableau,
api_version = 3.19,
group_id,
page_size = 100,
page_number = 1
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The version of the API to use, such as 3.21. |
group_id |
The ID of the group to get the users for. |
page_size |
The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. |
page_number |
The offset for paging. The default is 1. |
Value
A list of users in the specified group.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get folder names
Description
Get folder names
Usage
get_variable_folders(wb)
Arguments
wb |
The path to the Tableau workbook file [.twb]. |
Value
Dataframe containing the variable folder names
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variables(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get variable names from workbook.
Description
Get variable names from workbook.
Usage
get_variables(wb)
Arguments
wb |
The path to the Tableau workbook file [.twb]. |
Value
Dataframe
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_workbook_id(),
get_workbook_tabs(),
make_rootnodes()
Get workbook ID name.
Description
Get workbook ID name.
Usage
get_workbook_id(wb)
Arguments
wb |
The path to the Tableau workbook [.twb]. |
Value
The ID name of the workbook.
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_tabs(),
make_rootnodes()
Get workbook tabs
Description
Get workbook tabs
Usage
get_workbook_tabs(wb)
Arguments
wb |
The path to the Tableau workbook file [.twb]. |
Value
Dataframe
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
make_rootnodes()
Get Workbook URLs
Description
This function parses an XML document representing a Tableau workbook and finds all nodes that have a url attribute containing 'views'. It then extracts these URLs and returns them in a data frame.
Usage
get_workbook_urls(wb)
Arguments
wb |
The path to the Tableau workbook file (.twb). |
Value
A data frame containing the URLs found in the workbook.
make_rootnodes
Description
make_rootnodes
Usage
make_rootnodes(wb)
Arguments
wb |
The path to the tableau workbook file [.twb]. |
Value
The rootnodes.
See Also
Other xml:
adjust_tableau_size(),
check_dashboard_names(),
get_actions(),
get_folders(),
get_hierarchy(),
get_nodenames(),
get_parameter(),
get_revision(),
get_server_location(),
get_tableau_data_source(),
get_variable_folders(),
get_variables(),
get_workbook_id(),
get_workbook_tabs()
Query User On Site
Description
Returns information about the specified user.
Usage
query_user_on_site(tableau, user_id, api_version = 3.19)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
user_id |
The ID of the user to get information for. |
api_version |
The API version to use (default: 3.19). |
Value
Information about the specified user.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Remove User from Group
Description
Removes a user from the specified group.
Usage
remove_user_from_group(tableau, api_version = 3.19, group_id, user_id)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The version of the API to use, such as 3.19 (default: 3.19). |
group_id |
The ID of the group to remove the user from. |
user_id |
The ID of the user to remove. |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Remove User from Site
Description
Removes a user from the specified site. The user will be deleted if they do not own any other assets other than subscriptions. If a user still owns content (assets) on Tableau Server, the user cannot be deleted unless the ownership is reassigned first.
Usage
remove_user_from_site(tableau, api_version = 3.19, user_id, mapAssetsTo = NULL)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', 'user_id', and 'site_id'. |
api_version |
The version of the API to use, such as 3.19 (default: 3.19). |
user_id |
The ID of the user to remove. |
mapAssetsTo |
Optional. The ID of a user that receives ownership of contents of the user being removed. |
Value
No return value.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Concat row to name
Description
Concat row to name
Usage
row_to_name(row)
Arguments
row |
row of dataframe |
Value
namr of the row
Dataframe row to query
Description
Dataframe row to query
Usage
row_to_query(row)
Arguments
row |
row of dataframe |
Value
Query to the api call
Run Extract Refresh Task
Description
Runs the specified extract refresh task on Tableau Server.
Usage
run_extract_refresh_task(tableau, task_id, api_version = 3.22)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
task_id |
The ID of the extract refresh task to run. |
api_version |
The API version to use (default: 3.22). |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
update_data_source_now(),
update_group(),
update_user(),
update_workbook_now()
Get the Tableau base URL from the environment variable
Description
Get the Tableau base URL from the environment variable
Usage
tableau_base_url()
Value
The Tableau base URL stored in the TABLEAU_BASE_URL environment variable.
Get the Tableau content URL from the environment variable
Description
Get the Tableau content URL from the environment variable
Usage
tableau_content_url()
Value
The Tableau content URL stored in the TABLEAU_CONTENT_URL environment variable.
Get the Tableau password from the environment variable
Description
Get the Tableau password from the environment variable
Usage
tableau_password()
Value
The Tableau password stored in the TABLEAU_PASSWORD environment variable.
Get the Tableau PAT name from the environment variable
Description
Get the Tableau PAT name from the environment variable
Usage
tableau_pat_name()
Value
The Tableau PAT name stored in the TABLEAU_PAT_NAME environment variable.
Get the Tableau PAT secret from the environment variable
Description
Get the Tableau PAT secret from the environment variable
Usage
tableau_pat_secret()
Value
The Tableau PAT secret stored in the TABLEAU_PAT_SECRET environment variable.
Get the Tableau username from the environment variable
Description
Get the Tableau username from the environment variable
Usage
tableau_username()
Value
The Tableau username stored in the TABLEAU_USERNAME environment variable.
Update Data Source Now
Description
Runs an extract refresh on the specified data source.
Usage
update_data_source_now(tableau, datasource_id, api_version = 3.22)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
datasource_id |
The ID of the data source to refresh. |
api_version |
The API version to use (default: 3.22). |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_group(),
update_user(),
update_workbook_now()
Update Group
Description
Updates a group on a Tableau Server or Tableau Cloud site.
Usage
update_group(
tableau,
group_id,
group_name = NULL,
AD_group_name = NULL,
AD_domain = NULL,
minimum_site_role = NULL,
license_mode = NULL,
on_demand_access = NULL,
asJob = FALSE,
api_version = 3.19
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
group_id |
The ID of the group to update. |
group_name |
The new name for the group (optional). |
AD_group_name |
The name of the Active Directory group to synchronize with (optional). |
AD_domain |
The domain for the Active Directory group (optional). |
minimum_site_role |
Required if an import element or grantLicenseMode attribute are present in the request. The site role assigned to users who are imported from Active Directory or granted a license automatically using the grant license on-sync or on-login mode. |
license_mode |
Optional. The mode for automatically applying licenses for group members. When the mode is onLogin, a license is granted for each group member when they log in to a site. |
on_demand_access |
Optional. A boolean value that is used to enable on-demand access for embedded Tableau content when the Tableau Cloud site is licensed with Embedded Analytics usage-based model. |
asJob |
A Boolean value indicating whether to synchronize with Active Directory as a background task (true) or synchronize immediately (false). Default is false. |
api_version |
The API version to use (default: 3.19). |
Value
TRUE if the operation was successful, FALSE otherwise.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_user(),
update_workbook_now()
Update User
Description
Modifies information about the specified user.
Usage
update_user(
tableau,
user_id,
fullName = NULL,
email = NULL,
password = NULL,
siteRole,
authSetting = NULL,
api_version = 3.19
)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
user_id |
The ID of the user to update. |
fullName |
The new name for the user (optional). |
email |
The new email address for the user (optional). |
password |
The new password for the user (optional). |
siteRole |
The new site role to assign to the user. |
authSetting |
The authentication type for the user (optional). |
api_version |
The API version to use (default: 3.19). |
Value
TRUE if the operation was successful, FALSE otherwise.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_workbook_now()
Update Workbook Now
Description
Refreshes the specified workbook.
Usage
update_workbook_now(tableau, workbook_id, api_version = 3.22)
Arguments
tableau |
A list containing the Tableau authentication variables: 'base_url', 'token', and 'site_id'. |
workbook_id |
The ID of the workbook to refresh. |
api_version |
The API version to use (default: 3.22). |
Value
The response from the API.
See Also
Other Tableau REST API:
add_tags_to_view(),
add_tags_to_workbook(),
add_user_to_group(),
add_user_to_site(),
authenticate_PAT(),
authenticate_server(),
create_group(),
delete_group(),
download_datasource(),
download_filtered_tableau_image(),
download_tableau_crosstab_excel(),
download_tableau_data(),
download_workbooks_server(),
download_workbooks_server_pdf(),
download_workbooks_server_powerpoint(),
get_groups_for_user(),
get_mobile_security_settings(),
get_server_connected_apps(),
get_server_datasources(),
get_server_groups(),
get_server_info(),
get_server_jobs(),
get_server_projects(),
get_server_refresh_tasks(),
get_server_schedules(),
get_server_user_favorites(),
get_server_users(),
get_server_views(),
get_server_workbooks(),
get_table_assets(),
get_users_in_group(),
query_user_on_site(),
remove_user_from_group(),
remove_user_from_site(),
run_extract_refresh_task(),
update_data_source_now(),
update_group(),
update_user()