API reference

The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Cloud resources programmatically. You can use this library to create your own custom applications.

The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, workbooks.get(), correspond to the endpoints for resources, such as workbooks, users, views, and data sources. The model classes (for example, the WorkbookItem class have attributes that represent the fields (name, id, owner_id) that are in the REST API request and response packages, or payloads.

• Authentication
  • TableauAuth class
  • PersonalAccessTokenAuth class
  • Auth methods
    • auth.sign_in
    • auth.sign_out
    • auth.switch_site
• Connections
  • ConnectionItem class
  • ConnectionCredentials class
• Data sources
  • DatasourceItem class
  • Datasources methods
    • datasources.delete
    • datasources.download
    • datasources.get
    • datasources.get_by_id
    • datasources.populate_connections
    • datasources.publish
    • datasources.refresh
    • datasources.update
    • datasource.update_connection
    • datasource.update_hyper_data
• Filters
  • Filter class
• Groups
  • GroupItem class
  • Groups methods
    • groups.add_user
    • groups.create
    • groups.create_AD_group
    • groups.delete
    • groups.get
    • groups.populate_users
    • groups.remove_user
    • groups.update
• Jobs
  • JobItem class
  • Jobs methods
    • jobs.get_by_id
    • jobs.cancel
    • jobs.wait_for_job
• Metadata
  • Metadata methods
    • metadata.query
• Metrics
  • MetricItem class
  • Metric methods
    • metrics.delete
    • metrics.get
    • metrics.get_by_id
    • metrics.update
• Projects
  • ProjectItem class
    • ProjectItem.ContentPermissions
  • Project methods
    • projects.create
    • projects.get
    • projects.update
    • projects.delete
    • projects.populate_permissions
    • projects.update_permission
    • projects.delete_permission
    • projects.populate_workbook_default_permissions
    • projects.populate_datasource_default_permissions
    • projects.populate_flow_default_permissions
    • projects.update_workbook_default_permissions
    • projects.update_datasource_default_permissions
    • projects.update_flow_default_permissions
    • projects.delete_workbook_default_permissions
    • projects.delete_datasource_default_permissions
    • projects.delete_flow_default_permissions
• Requests
  • RequestOptions class
    • RequestOptions.Field class
    • RequestOptions.Operator class
    • RequestOptions.Direction class
  • CSVRequestOptions class
  • ExcelRequestOptions class
  • ImageRequestOptions class
  • PDFRequestOptions class
• Schedules
  • ScheduleItem class
    • IntervalItem class
  • Schedule methods
    • schedules.add_to_schedule
    • schedules.create
    • schedules.delete
    • schedules.get
    • schedules.get_by_id
    • schedules.update
• Server
  • Server class
    • Server.Resources
    • Server.PublishMode
  • ServerInfoItem class
  • ServerInfo methods
    • server_info.get
• Sites
  • SiteItem class
  • Site methods
    • sites.create
    • sites.get
    • sites.get_by_id
    • sites.get_by_name
    • sites.update
    • sites.delete
• Sort
  • Sort class
• Subscriptions
  • SubscriptionItem class
  • Subscription methods
    • subscription.create
    • subscriptions.delete
    • subscription.get
    • subscription.get_by_id
    • subscription.update
• Tasks
  • TaskItem class
  • Tasks methods
    • tasks.get
    • tasks.get_by_id
    • tasks.run
    • tasks.delete
• Users
  • UserItem class
  • Users methods
    • users.add
    • users.get
    • users.get_by_id
    • users.populate_favorites
    • users.populate_groups
    • users.populate_workbooks
    • users.remove
    • users.update
• Views
  • ViewItem class
  • Views methods
    • views.get
    • views.get_by_id
    • views.populate_preview_image
    • views.populate_image
    • views.populate_csv
    • views.populate_pdf
• Webhooks
  • WebhookItem class
  • Webhook methods
    • webhook.create
      • Parmeters
  • webhook.delete
    • webhook.get()
    • webhook.get_by_id
  • Additional Resources
• Workbooks
  • WorkbookItem class
  • Workbook methods
    • workbooks.get
    • workbooks.get_by_id
    • workbooks.publish
    • workbooks.refresh
    • workbooks.update
    • workbooks.delete
    • workbooks.download
    • workbooks.populate_views
    • workbooks.populate_connections
    • workbooks.populate_preview_image
    • workbooks.update_connection
    • workbooks.populate_pdf

Authentication

You can use the TSC library to sign in and sign out of Tableau Server and Tableau Cloud. The credentials for signing in are defined in the TableauAuth class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API.

TableauAuth class

TableauAuth(username, password, site_id='', user_id_to_impersonate=None)

The TableauAuth class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the Auth.sign_in method.

Note: In the future, there might be support for additional forms of authorization and authentication (for example, OAuth).

Attributes

Source file: models/tableau_auth.py

Example

import tableauserverclient as TSC

tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL')
server = TSC.Server('https://SERVER_URL', use_server_version=True)
server.auth.sign_in(tableau_auth)

PersonalAccessTokenAuth class

PersonalAccessTokenAuth(token_name, personal_access_token, site_id='')

The PersonalAccessTokenAuth class serves the same purpose and is used in the same way as TableauAuth, but using Personal Access Tokens instead of username and password.

Attributes

Source file: models/personal_access_token_auth.py

Example

import tableauserverclient as TSC

tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN-NAME', 'TOKEN-VALUE', site_id='CONTENTURL')
server = TSC.Server('https://SERVER_URL', use_server_version=True)
server.auth.sign_in(tableau_auth)

Auth methods

The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API.

Source file: server/endpoint/auth_endpoint.py

See Also Sign in and Out Server

auth.sign_in

auth.sign_in(auth_req)

Signs you in to Tableau Server.

The method signs into Tableau Server or Tableau Cloud and manages the authentication token. You call this method from the server object you create. For information about the server object, see Server. The authentication token keeps you signed in for 240 minutes, or until you call the auth.sign_out method. Before you use this method, you first need to create the sign-in request (auth_req) object by creating an instance of the TableauAuth. To call this method, create a server object for your server. For more information, see Sign in and Out.

REST API: Sign In

Parameters

auth_req : The TableauAuth object that holds the sign-in credentials for the site.

Example

import tableauserverclient as TSC

# create an auth object
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')

# create an instance for your server
server = TSC.Server('https://SERVER_URL')

# call the sign-in method with the auth object
server.auth.sign_in(tableau_auth)

auth.sign_out

auth.sign_out()

Signs you out of the current session.

The sign_out() method takes care of invalidating the authentication token. For more information, see Sign in and Out.

REST API: Sign Out

Example

server.auth.sign_out()

auth.switch_site

auth.switch_site(site_id)

Switch to a different site on the current Tableau Server.

Switching avoids the need for reauthenticating to the same server. (Note: This method is not available in Tableau Cloud.)

REST API: Switch Site

Parameters

Example

# find and then switch auth to another site on the same server
site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d')
server.auth.switch_site(site)

See Also
Sign in and Out
Server

Connections

The connections for Tableau Server data sources and workbooks are represented by a ConnectionItem class. You can call data source and workbook methods to query or update the connection information. The ConnectionCredentials class represents the connection information you can update.

ConnectionItem class

ConnectionItem()

The ConnectionItem class corresponds to workbook and data source connections.

In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections.

Attributes

Source file: models/connection_item.py

ConnectionCredentials class

ConnectionCredentials(name, password, embed=True, oauth=False)

The ConnectionCredentials class is used for workbook and data source publish requests.

Attributes

Source file: models/connection_credentials.py

Data sources

Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. The data source resources for Tableau Server are defined in the DatasourceItem class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the DatasourceItem class.

DatasourceItem class

DatasourceItem(project_id, name=None)

The DatasourceItem represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new DatasourceItem instance, you must specify the project_id that the data source is associated with.

Attributes

Example

    import tableauserverclient as TSC

    # Create new datasource_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39'

    new_datasource = TSC.DatasourceItem('3a8b6148-493c-11e6-a621-6f3499394a39')

Source file: models/datasource_item.py

Datasources methods

The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API.

Source file: server/endpoint/datasources_endpoint.py

datasources.delete

datasources.delete(datasource_id)

Removes the specified data source from Tableau Server.

Parameters

Exceptions

REST API: Delete Datasource

datasources.download

datasources.download(datasource_id, filepath=None, include_extract=True, no_extract=None)

Downloads the specified data source in .tdsx or .hyper format.

REST API: Download Datasource

Parameters

Exceptions

Returns

The file path to the downloaded data source. The data source is downloaded in .tdsx or .hyper format.

Example

  file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b')
  print("\nDownloaded the file to {0}.".format(file_path))

datasources.get

datasources.get(req_options=None)

Returns all the data sources for the site.

To get the connection information for each data source, you must first populate the DatasourceItem with connection information using the populate_connections(datasource_item) method. For more information, see Populate Connections and Views

REST API: Query Datasources

Parameters

Returns

Returns a list of DatasourceItem objects and a PaginationItem object. Use these values to iterate through the results.

Example

import tableauserverclient as TSC
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
server = TSC.Server('https://SERVERURL')

with server.auth.sign_in(tableau_auth):
    all_datasources, pagination_item = server.datasources.get()
    print("\nThere are {} datasources on site: ".format(pagination_item.total_available))
    print([datasource.name for datasource in all_datasources])

datasources.get_by_id

datasources.get_by_id(datasource_id)

Returns the specified data source item.

REST API: Query Datasource

Parameters

Exceptions

Returns

The DatasourceItem. See DatasourceItem class

Example

datasource = server.datasources.get_by_id('59a57c0f-3905-4022-9e87-424fb05e9c0e')
print(datasource.name)

datasources.populate_connections

datasources.populate_connections(datasource_item)

Populates the connections for the specified data source.

This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (datasource_item.connections). This is a list of ConnectionItem objects.

REST API: Query Datasource Connections

Parameters

Exceptions

Returns

None. A list of ConnectionItem objects are added to the data source (datasource_item.connections).

Example

# import tableauserverclient as TSC

# server = TSC.Server('https://SERVERURL')
#
   ...

# get the data source
  datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b')


# get the connection information
  server.datasources.populate_connections(datasource)

# print the information about the first connection item
  connection = datasource.connections[0]
  print(connection.connection_type)
  print(connection.id)
  print(connection.server_address)

  ...

datasources.publish

datasources.publish(datasource_item, file, mode, connection_credentials=None, as_job=False)

Publishes a data source to a server, or appends data to an existing data source.

This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one operation.

REST API: Publish Datasource

Parameters

Exceptions

Returns

The DatasourceItem for the data source that was added or appended to.

Example

  import tableauserverclient as TSC
  server = TSC.Server('https://SERVERURL')

  ...

  project_id = '3a8b6148-493c-11e6-a621-6f3499394a39'
  file_path = r'C:\temp\WorldIndicators.tde'


  # Use the project id to create new datsource_item
  new_datasource = TSC.DatasourceItem(project_id)

  # publish data source (specified in file_path)
  new_datasource = server.datasources.publish(
                    new_datasource, file_path, 'CreateNew')

    ...

datasources.refresh

datasources.refresh(datasource_item)

Refreshes the data of the specified extract.

REST API: Update Data Source Now

Parameters

Exceptions

Returns

A refreshed JobItem.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://SERVERURL')
# sign in ...

# get the data source item to update
  datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b')

# call the refresh method with the data source item
  refreshed_datasource = server.datasources.refresh(datasource)

datasources.update

datasource.update(datasource_item)

Updates the specified data source.

REST API: Update Data Source

Parameters

Exceptions

Returns

An updated DatasourceItem.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://SERVERURL')
# sign in ...

# get the data source item to update
  datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b')

# do some updating
  datasource.owner_id = 'New Owner ID'

# call the update method with the data source item
  updated_datasource = server.datasources.update(datasource)

datasource.update_connection

datasource.update_connection(datasource_item, connection_item)

Updates the server address, port, username, or password for the specified data source connection.

REST API: Update Datasource Connection

Parameters

Returns

An updated ConnectionItem for the data source.

Example

See the update_connection.py sample in the Samples directory.

datasource.update_hyper_data

datasource.update_hyper_data(datasource_or_connection_item, *, request_id, actions, payload=None)

Updates the data contained within a published live-to-Hyper datasource.

REST API: Update Data in Hyper Data Source

Version

This endpoint is available with REST API version 3.13 and up.

Parameters

For more information on the actions, see the REST API docs on “Action batch description”. To create a payload Hyper file, you can use Hyper API or pantab.

Returns

A JobItem for the update job on the server. Upon completion of this job, the data was updated.

Example

See the update_datasource_data.py sample in the Samples directory.

Filters

The TSC library provides a Filter class that you can use to filter results returned from the server.

You can use the Filter and RequestOptions classes to filter and sort the following endpoints:

• Users
• Datasources
• Workbooks
• Views

For more information, see Filter and Sort.

Filter class

Filter(field, operator, value)

The Filter class corresponds to the filter expressions in the Tableau REST API.

Attributes

Groups

Using the TSC library, you can get information about all the groups on a site, you can add or remove groups, or add or remove users in a group.

The group resources for Tableau Server are defined in the GroupItem class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the GroupItem class.

GroupItem class

GroupItem(name)

The GroupItem class contains the attributes for the group resources on Tableau Server. The GroupItem class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload.

Source file: models/group_item.py

Attributes

Example

 newgroup = TSC.GroupItem('My Group')

 # call groups.create() with new group

Groups methods

The Tableau Server Client provides several methods for interacting with group resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API.

Source file: server/endpoint/groups_endpoint.py

groups.add_user

groups.add_user(group_item, user_id):

Adds a user to the specified group.

REST API Add User to Group

Parameters

Returns

None.

Example

# Adding a user to a group
#
# get the group item
  all_groups, pagination_item = server.groups.get()
  mygroup = all_groups[1]

# The id for Ian is '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba'

# add Ian to the group
  server.groups.add_user(mygroup, '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba')

groups.create

create(group_item)

Creates a new local group in Tableau Server.

REST API: Create Group

Parameters

Returns Adds new GroupItem.

Example

# Create a new group

#  import tableauserverclient as TSC
#  tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
#  server = TSC.Server('https://SERVERURL')


# create a new instance with the group name
  newgroup = TSC.GroupItem('My Group')
  newgroup.minimum_site_role = TSC.UserItem.Roles.ExplorerCanPublish

# call the create method
  newgroup = server.groups.create(newgroup)

# print the names of the groups on the server
  all_groups, pagination_item = server.groups.get()
  for group in all_groups :
      print(group.name, group.id)

groups.create_AD_group

create_AD_group(group_item, asJob=False)

Creates an active directory group in Tableau Server.

REST API: Create Group

Parameters

Returns Returns the created GroupItem or a JobItem if asJob flag was set to True.

Example

# Create a new group

#  import tableauserverclient as TSC
#  tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
#  server = TSC.Server('https://SERVERURL')


# create a new instance with the group name
  newgroup = TSC.GroupItem('AD_Group_Name', 'AD_Domain_Name')
  newgroup.minimum_site_role = TSC.UserItem.Roles.SiteAdministratorExplorer
  newgroup.license_mode = TSC.GroupItem.LicenseMode.onSync

# call the create method
  newgroup = server.groups.create_AD_group(newgroup)
  
# call the create method asynchronously
  newgroup_job = server.groups.create_AD_group(newgroup, asJob=True)

groups.delete

groups.delete(group_id)

Deletes the group on the site.

REST API: Delete Group

Parameters

Exceptions

Example

#  Delete a group from the site

# import tableauserverclient as TSC
# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
# server = TSC.Server('https://SERVERURL')

  with server.auth.sign_in(tableau_auth):
     server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d')

groups.get

groups.get(req_options=None)

Returns information about the groups on the site.

To get information about the users in a group, you must first populate the GroupItem with user information using the groups.populate_users method.

REST API: Get Users on Site

Parameters

Returns

Returns a list of GroupItem objects and a PaginationItem object. Use these values to iterate through the results.

Example

# import tableauserverclient as TSC
# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
# server = TSC.Server('https://SERVERURL')

  with server.auth.sign_in(tableau_auth):

       # get the groups on the server
       all_groups, pagination_item = server.groups.get()

       # print the names of the first 100 groups
       for group in all_groups :
           print(group.name, group.id)

groups.populate_users

groups.populate_users(group_item, req_options=None)

Populates the group_item with the list of users.

REST API: Get Users in Group

Parameters

Exceptions

Group item missing ID. Group must be retrieved from server first. : Raises an error if the group_item is unspecified.

Returns

None. A list of UserItem objects are added to the group (group_item.users).

Example

# import tableauserverclient as TSC

# server = TSC.Server('https://SERVERURL')
#
   ...

# get the group
  all_groups, pagination_item = server.groups.get()
  mygroup = all_groups[1]

# get the user information
  pagination_item = server.groups.populate_users(mygroup)


# print the names of the users
  for user in mygroup.users :
        print(user.name)

groups.remove_user

groups.remove_user(group_item, user_id)

Removes a user from a group.

REST API: Remove User from Group

Parameters

Exceptions

Returns

None. The user is removed from the group.

Example

#  Remove a user from a group

# import tableauserverclient as TSC
# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
# server = TSC.Server('https://SERVERURL')

  with server.auth.sign_in(tableau_auth):

     # get a group
     all_groups, pagination_item = server.groups.get()
     mygroup = all_groups[0]

     # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d'
     server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d')

groups.update

groups.update(group_item, as_job=False)

Updates a group in Tableau Server.

REST API: Update Group

Parameters

Exceptions

Returns

The updated GroupItem object. If as_job was set to True, a JobItem will be returned instead.

Example

# Fetch an existing group from server.
groups, pagination = server.groups.get()
group = groups[0]

# Set update-able fields. Any of these can be added or removed.
## Local group
group.name = "new group name"
group.minimum_site_role = TSC.UserItem.Roles.SiteAdministratorExplorer

## Active Directory group
group.minimum_site_role = TSC.UserItem.Roles.SiteAdministratorExplorer
group.license_mode = TSC.GroupItem.LicenseMode.onLogin

# Update group - synchronous
group = server.groups.update(group)

# Update group - asynchronous (only for Active Directory groups)
job = server.groups.update(group, as_job=True)

Jobs

Using the TSC library, you can get information about an asynchronous process (or job) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an asJob parameter (asJob-true) that creates a background process (the job) to complete the call. Information about the asynchronous job is returned from the method.

If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job.

The job properties are defined in the JobItem class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the JobItem class.

JobItem class

JobItem(id, type, created_at, started_at=None, completed_at=None, finish_code=0)

The JobItem class contains information about the specified job running on Tableau Server. The JobItem class defines the information you can query from Tableau Server. The class members correspond to the attributes of a server response payload.

Source file: models/job_item.py

Attributes

Jobs methods

The Jobs methods are based upon the endpoints for jobs in the REST API and operate on the JobItem class.

Source files: server/endpoint/jobs_endpoint.py

jobs.get_by_id

jobs.get_by_id(job_id)

Gets information about the specified job.

REST API: Query Job

Parameters

Exceptions

Returns

Returns the JobItem requested.

Example

#  Query a Job

# import tableauserverclient as TSC
# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
# server = TSC.Server('https://SERVERURL')

  with server.auth.sign_in(tableau_auth):

     # get the id of the job from response to extract refresh task,
     # or another asynchronous REST API call.
     # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548"


    myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548'
    jobinfo = server.jobs.get_by_id(myJobId)

    print(jobinfo)

    # <Job#576b616d-341a-4539-b32c-1ed0eb9db548 RefreshExtract created_at(2018-04-10T23:43:21Z) started_at(2018-04-10T23:43:25Z) completed_at(2018-04-10T23:43:26Z) finish_code(1)>

jobs.cancel

jobs.cancel(job_id)

Cancels the currently running job. Can be used to cancel currently running jobs like extract refreshes.

Parameters

Exceptions

Returns Returns the details of the canceled job including the URL of the site where the job was created.

Example

#  Query a Job

# import tableauserverclient as TSC
# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
# server = TSC.Server('https://SERVERURL')

  with server.auth.sign_in(tableau_auth):

     # get the id of the job from response from the query job method.
     # in this example, "576b781d-331c-4539-b61d-1ed0eb9db548"
    cancelJobId = '576b781d-331c-4539-b61d-1ed0eb9db548'
    jobs.cancel (cancelJobId)

jobs.wait_for_job

jobs.wait_for_job(job_id, *, timeout=None)

Waits until a given job succesfully finishes. Repeatedly polls the server using jobs.get_by_id until the job completed. It uses an exponentially increasing sleep time between polls to guarantee a snappy response time for fast-running jobs while not putting overly large load on the server for long-running jobs.

In case the job fails or is cancelled, wait_for_job will raise an exception.

Parameters

Returns

Returns the final JobItem.

Usually, you can just discard the return value without checking the job status. In case the job wasn’t succesful, wait_for_job would have already raised an exception. For advanced scenarios, he returned JobItem might still be interesting to access e.g. start and end time or notes.

Example

See the update_datasource_data.py or refresh.py sample in the Samples directory.

Metadata

Using the metadata endpoint, one can use GraphQL to query metadata on, e.g., workbooks, datasources, the fields contained within them, and the relationships between them.

Metadata methods

The Metadata methods call the Metadata API which is a GraphQL interface allowing to query metadata about objects on the server (workbooks, datasources, …) and the relationships between them.

Source files: server/endpoint/metadata_endpoint.py

metadata.query

metadata.query(query, variables=None, abort_on_error=False)

Executes a metadata query and returns the result.

Parameters

Returns

The method returns the query results as a stucture of lists and dicts as returned by the json package.

Example

See the metadata_query.py sample in the Samples directory.

Metrics

Using the TSC library, you can get information about all metrics on a site, update, or delete metrics.

MetricItem class

MetricItem(name: Optional[str]=None)

The metrics resources for Tableau are defined in the MetricItem class. The class corresponds to the metric resource you can access using the Tableau Server REST API.

Attributes Name | Description :— | :— name | Name of the metric id | The REST API id for the metric description | The description of the metric webpage_url | The URL for the metric created_at | The datetime object for when the metric was created updated_at | The datetime object for when the metric was updated suspended | Boolean for if the metric is in a suspended state project_id | REST API id for the project containing the metric project_name | The name of the project containing the metric owner_id | REST API id for the user who owns the metric view_id | REST API id for the view from which the metric was created

Source file: models/metric_item.py

Metric methods

The metric methods are based upon the endpoints for metrics in the REST API and operate on the MetricItem class. The metrics endpoint also supports the django style filtering. See Filter and Sort for more information.

Source files: server/endpoint/metrics_endpoint.py

metrics.delete

metrics.delete(metric_id)

Deletes a metric item from a site.

To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Delete Metric

Parameters

Returns

None

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc

server.metrics.delete("6561daa3-20e8-407f-ba09-709b178c0b4a")

metrics.get

metrics.get()

Return a list of metrics items for a site.

To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: List Metrics for Site

Parameters

None.

Returns

Returns a Tuple containing a list of all MetricItem objects and a PaginationItem. Use these values to iterate through the results.

Example

import tableauserverclient as TSC
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL')
server = TSC.Server('https://SERVER')

with server.auth.sign_in(tableau_auth):
        # get all metrics on site
        all_metric_items, pagination_item = server.metrics.get()
        print([metric.name for metric in all_metric_items])

metrics.get_by_id

metrics.get_by_id(metric_id)

Return a specific metric item from the site.

To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Get Metric

Parameters

Returns

Returns a MetricItem object corresponding to the ID requested.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc

server.metrics.get_by_id("6561daa3-20e8-407f-ba09-709b178c0b4a")

metrics.update

metrics.update(item)

Updates a metric item on the Tableau Server.

To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Update Metric

Parameters

Returns

Returns a MetricItem object reflecting the changes applied to Tableau Server.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc

metric = server.metrics.get_by_id("6561daa3-20e8-407f-ba09-709b178c0b4a")
metric.owner_id = "1bbbc2b9-847d-443c-9a1f-dbcf112b8814"
server.metrics.update(metric)

Projects

Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects.

The project resources for Tableau are defined in the ProjectItem class. The class corresponds to the project resources you can access using the Tableau Server REST API. The project methods are based upon the endpoints for projects in the REST API and operate on the ProjectItem class.

ProjectItem class

ProjectItem(name, description=None, content_permissions=None,  parent_id=None)

The project resources for Tableau are defined in the ProjectItem class. The class corresponds to the project resources you can access using the Tableau Server REST API.

Attributes

Source file: models/project_item.py

ProjectItem.ContentPermissions

The ProjectItem class has a sub-class that defines the permissions for the project (ProjectItem.ContentPermissions). The options are LockedToProject, ManagedByOwner and LockedToProjectWithoutNested. For information on these content permissions, see Lock Content Permissions to the Project.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc


locked_true = TSC.ProjectItem.ContentPermissions.LockedToProject
print(locked_true)
# prints 'LockedToProject'

by_owner = TSC.ProjectItem.ContentPermissions.ManagedByOwner
print(by_owner)
# prints 'ManagedByOwner'


# pass the content_permissions to new instance of the project item.
new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example')

Project methods

The project methods are based upon the endpoints for projects in the REST API and operate on the ProjectItem class.

Source files: server/endpoint/projects_endpoint.py

projects.create

projects.create(project_item)

Creates a project on the specified site.

To create a project, you first create a new instance of a ProjectItem and pass it to the create method. To specify the site to create the new project, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Create Project

Parameters

Returns Returns the new project item.

Example

import tableauserverclient as TSC
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL')
server = TSC.Server('https://SERVER')

with server.auth.sign_in(tableau_auth):
    # create project item
    new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing')
    # create the project
    new_project = server.projects.create(new_project)

projects.get

projects.get()

Return a list of project items for a site.

To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Query Projects

Parameters

None.

Returns

Returns a list of all ProjectItem objects and a PaginationItem. Use these values to iterate through the results.

Example

import tableauserverclient as TSC
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL')
server = TSC.Server('https://SERVER')

with server.auth.sign_in(tableau_auth):
        # get all projects on site
        all_project_items, pagination_item = server.projects.get()
        print([proj.name for proj in all_project_items])

projects.update

projects.update(project_item)

Modify the project settings.

You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Update Project

Parameters

Exceptions

Returns

Returns the updated project information.

See ProjectItem class

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc

  ...
  # get list of projects
  all_project_items, pagination_item = server.projects.get()


  # update project item #7 with new name, etc.
  my_project = all_projects[7]
  my_project.name ='New name'
  my_project.description = 'New description'

  # call method to update project
  updated_project = server.projects.update(my_project)

projects.delete

projects.delete(project_id)

Deletes a project by ID.

To specify the site, create a TableauAuth instance using the content URL for the site (site_id), and sign in to that site. See the TableauAuth class.

REST API: Delete Project

Parameters

Exceptions

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc.

 server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e')

projects.populate_permissions

projects.populate_permissions(item)

Queries the project permissions, parses and stores the returned the permissions.

REST API: Query Project Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 server.projects.populate_permissions(project_item)

projects.update_permission

projects.update_permission(item, rules)

Add project permissions for a user or group.

REST API: Add Project Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 project_capabilities = {
   TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
 }

 project_rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=project_capabilities
 )
 
 server.projects.update_permission(project_item, [project_rules])

projects.delete_permission

projects.delete_permission(item, rules)

Delete project permissions.

REST API: Delete Project Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 project_capabilities = {
   TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
 }

 project_rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=project_capabilities
 )
 
 server.projects.delete_permission(project_item)

projects.populate_workbook_default_permissions

projects.populate_workbook_default_permissions(item)

Queries the default workbook permissions, parses and stores the returned the permissions.

REST API: Query Default Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 server.projects.populate_workbook_default_permissions(project_item)

projects.populate_datasource_default_permissions

projects.populate_datasource_default_permissions(item)

Queries the default datasource permissions, parses and stores the returned the permissions.

REST API: Query Default Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 server.projects.populate_datasource_default_permissions(project_item)

projects.populate_flow_default_permissions

projects.populate_flow_default_permissions(item)

Queries the default flow permissions, parses and stores the returned the permissions.

REST API: Query Default Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 server.projects.populate_flow_default_permissions(project_item)

projects.update_workbook_default_permissions

projects.update_workbook_default_permissions(item, rules)

Add or update default workbook permissions.

REST API: Add Default Workbook Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 capabilities = {
   TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow
 }

 rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=capabilities
 )
 
 server.projects.update_workbook_default_permissions(project_item, [rules])

projects.update_datasource_default_permissions

projects.update_datasource_default_permissions(item, rules)

Add or update default datasource permissions.

REST API: Add Default Datasource Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 capabilities = {
   TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow
 }

 rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=capabilities
 )
 
 server.projects.update_datasource_default_permissions(project_item, [rules])

projects.update_flow_default_permissions

projects.update_flow_default_permissions(item, rules)

Add or update default flow permissions.

REST API: Add Default Flow Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 capabilities = {
   TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
 }

 rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=capabilities
 )
 
 server.projects.update_flow_default_permissions(project_item, [rules])

projects.delete_workbook_default_permissions

projects.delete_workbook_default_permissions(item, rules)

Delete default workbook permissions.

REST API: Delete Default Workbook Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 capabilities = {
   TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow
 }

 rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=capabilities
 )
 
 server.projects.delete_workbook_default_permissions(project_item, [rules])

projects.delete_datasource_default_permissions

projects.delete_datasource_default_permissions(item, rules)

Delete default datasource permissions.

REST API: Delete Default Datasource Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 capabilities = {
   TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow
 }

 rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=capabilities
 )
 
 server.projects.delete_datasource_default_permissions(project_item, [rules])

projects.delete_flow_default_permissions

projects.delete_flow_default_permissions(item, rules)

Delete default flow permissions.

REST API: Delete Default Flow Permissions

Parameters

Example

# import tableauserverclient as TSC  
# server = TSC.Server('https://MY-SERVER')  
# sign in, etc.  

 all_project_items, pagination_item = server.projects.get()
 project_item = all_project_items[0]
 
 capabilities = {
   TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow
 }

 rules = TSC.PermissionsRule(
  grantee=project_item,
  capabilities=capabilities
 )
 
 server.projects.delete_flow_default_permissions(project_item, [rules])

Requests

The TSC library provides a RequestOptions class that you can use to filter results returned from the server.

You can use the Sort and RequestOptions classes to filter and sort the following endpoints:

• Users
• Datasources
• Groups
• Workbooks
• Views

You can use the ImageRequestOptions and PDFRequestOptions to set options for views returned as images and PDF files.

For more information about filtering and sorting, see Filter and Sort.

RequestOptions class

RequestOptions(pagenumber=1, pagesize=100)

Attributes

RequestOptions.Field class

The RequestOptions.Field class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see Filtering and Sorting in the Tableau REST API.

Attributes

Attributes

RequestOptions.Operator class

Specifies the operators you can use to filter requests.

Attributes

RequestOptions.Direction class

Specifies the direction to sort the returned fields.

Attributes

CSVRequestOptions class

CSVRequestOptions(maxage=-1)

Use this class to specify view filters to be applied when the CSV data is generated. Optionally, you can specify the maximum age of the CSV data cached on the server by providing a maxage value. See views.populate_csv.

Attributes

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, get a specific view, etc.

# set view filters
csv_req_option = TSC.CSVRequestOptions(maxage=5)
csv_req_option.vf('Region', 'South')
csv_req_option.vf('Category', 'Furniture')

# retrieve the csv data for the view
server.views.populate_csv(view_item, csv_req_option)

ExcelRequestOptions class

ExcelRequestOptions(maxage=-1)

Use this class to specify view filters to be applied when data is generated in an Excel file format. Optionally, you can specify the maximum age of the Excel data cached on the server by providing a maxage value. See views.populate_csv.

Attributes

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, get a specific view, etc.

# set view filters
excel_req_option = TSC.ExcelRequestOptions(maxage=5)
excel_req_option.vf('Region', 'South')
excel_req_option.vf('Category', 'Furniture')

# retrieve the excel data for the view
server.views.populate_excel(view_item, excel_req_option)

ImageRequestOptions class

ImageRequestOptions(imageresolution=None, maxage=-1)

Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See views.populate_image.

Attributes

View Filters

You can use the vf('filter_name', 'filter_value') method to add view filters. When the image is generated, the specified filters will be applied to the view.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, get a specific view, etc.

# set the image request option
image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1)

# (optional) set a view filter
image_req_option.vf('Category', 'Furniture')

# retrieve the image for the view
server.views.populate_image(view_item, image_req_option)

PDFRequestOptions class

PDFRequestOptions(page_type=None, orientation=None, maxage=-1)

Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a maxage value. See views.populate_pdf.

Attributes

View Filters You can use the vf('filter_name', 'filter_value') method to add view filters. When the PDF is generated, the specified filters will be applied to the view.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, get a specific view, etc.

# set the PDF request options
pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4,
				       orientation=TSC.PDFRequestOptions.Orientation.Landscape,
				       maxage=1)

# (optional) set a view filter
pdf_req_option.vf('Region', 'West')

# retrieve the PDF for a view
server.views.populate_pdf(view_item, pdf_req_option)

Schedules

Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks.

If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job.

The schedule properties are defined in the ScheduleItem class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the JobItem class.

ScheduleItem class

ScheduleItem(name, priority, schedule_type, execution_order, interval_item)

The ScheduleItem class contains information about the specified schedule running on Tableau Server. The ScheduleItem class defines the information you can query and set. The class members correspond to the attributes of a server response payload.

Source file: models/schedule_item.py

Attributes

IntervalItem class

This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface.

Attributes

Schedule methods

The schedule methods are based upon the endpoints for schedules in the REST API and operate on the ScheduleItem class.

Source files: server/endpoint/schedules_endpoint.py

schedules.add_to_schedule

schedules.add_to_schedule(schedule_id, workbook=None, datasource=None, flow=None, task_type=None)

Adds a DatasourceItem, FlowItem, or WorkbookItem to a schedule.

REST API: Add Data Source to Schedule

Parameters

Returns Returns a List of AddResponses.

Example

import tableauserverclient as TSC
# sign in, etc.
# get a datasource item that should be added to a schedule
datasource_item = server.datasources.get("d14dd951-01c1-4879-8bc2-e96d7dec9f0")

# retrieve the id of the target schedule 
schedule_id = schedule_item.id  # can be a freshly created schedule or one queried via `schedules.get()`

# Add the data source to the schedule
server.schedules.add_to_schedule(
    schedule_id=schedule_id,
    datasource=datasource_item,
)

schedules.create

schedules.create(schedule_item)

Creates a new schedule for an extract refresh or a subscription.

REST API: Create Schedule

Parameters

Returns

Returns a new instance of schedule_item.

Exceptions

Example

import tableauserverclient as TSC
from datetime import time

# sign in, etc.
# Create an interval to run every 2 hours between 2:30AM and 11:00PM
hourly_interval = TSC.HourlyInterval(start_time=time(2, 30),
                                     end_time=time(23, 0),
                                     interval_value=2)
# Create schedule item
hourly_schedule = TSC.ScheduleItem("Hourly-Schedule",
                                   50,
                                   TSC.ScheduleItem.Type.Extract,
                                   TSC.ScheduleItem.ExecutionOrder.Parallel,
                                   hourly_interval)
# Create schedule
hourly_schedule = server.schedules.create(hourly_schedule)

schedules.delete

schedules.delete(schedule_id)

Deletes an existing schedule for an extract refresh or a subscription.

REST API: Delete Schedule

Parameters

Returns

None.

Exceptions

schedules.get

schedules.get()

Returns all schedule items from the server.

REST API: Query Schedules

schedules.get_by_id

schedules.get_by_id(schedule_id)

Returns the specified schedule.

REST API: Get Schedule

Parameters

schedules.update

schedules.update(schedule_item)

Parameters

REST API: Update Schedules

Hourly schedule example

import tableauserverclient as TSC
from datetime import time
# sign in, etc.

# Create an interval to run every 2 hours between 2:30AM and 11:00PM
hourly_interval = TSC.HourlyInterval(start_time=time(2, 30),
                                     end_time=time(23, 0),
                                     interval_value=2)

# Create schedule item
hourly_schedule = TSC.ScheduleItem("Hourly-Schedule",
                                   50,
                                   TSC.ScheduleItem.Type.Extract,
                                   TSC.ScheduleItem.ExecutionOrder.Parallel,
                                   hourly_interval)

# Create schedule
hourly_schedule = server.schedules.create(hourly_schedule)

Daily schedule example

import tableauserverclient as TSC
from datetime import time
# sign in, etc.

# Create a daily interval to run every day at 12:30AM
daily_interval = TSC.DailyInterval(start_time=time(0, 30))

# Create schedule item using daily interval
daily_schedule = TSC.ScheduleItem("Daily-Schedule",
                                  60,
                                  TSC.ScheduleItem.Type.Subscription,
                                  TSC.ScheduleItem.ExecutionOrder.Serial,
                                  daily_interval)

# Create daily schedule
daily_schedule = server.schedules.create(daily_schedule)

Weekly schedule example

import tableauserverclient as TSC
from datetime import time
# sign in, etc.

# Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM
weekly_interval = TSC.WeeklyInterval(time(19, 15),
                                     TSC.IntervalItem.Day.Monday,
                                     TSC.IntervalItem.Day.Wednesday,
                                     TSC.IntervalItem.Day.Friday)
# Create schedule item using weekly interval
weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70,
                                  TSC.ScheduleItem.Type.Extract,
                                  TSC.ScheduleItem.ExecutionOrder.Serial,
                                  weekly_interval)
# Create weekly schedule
weekly_schedule = server.schedules.create(weekly_schedule)

Monthly schedule example

import tableauserverclient as TSC
from datetime import time
# sign in, etc.

# Create a monthly interval to run on the 15th of every month at 11:30PM
monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30),
                                        interval_value=15)
# Create schedule item using monthly interval
monthly_schedule = TSC.ScheduleItem("Monthly-Schedule",
                                    80,
                                    TSC.ScheduleItem.Type.Subscription
                                    TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval)
# Create monthly schedule
monthly_schedule = server.schedules.create(monthly_schedule)

Server

In the Tableau REST API, the server (https://MY-SERVER/) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) The TSC library provides a Server class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources.

Server class

Server(server_address)

The Server class contains the attributes that represent the server on Tableau Server. After you create an instance of the Server class, you can sign in to the server and call methods to access all of the resources on the server.

Attributes

Example

import tableauserverclient as TSC


# create a instance of server
server = TSC.Server('https://MY-SERVER')

# sign in, etc.

# change the REST API version to match the server
server.use_server_version()

# or change the REST API version to match a specific version
# for example, 2.8
# server.version = '2.8'

Server.Resources

When you create an instance of the Server class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: server.views.get()

Server.PublishMode

The Server class has PublishMode class that enumerates the options that specify what happens when you publish a workbook or data source. The options are Overwrite, Append, or CreateNew.

Properties

Example

 import tableauserverclient as TSC
 # login, etc.

 print(TSC.Server.PublishMode.Overwrite)
 # prints 'Overwrite'

 overwrite_true = TSC.Server.PublishMode.Overwrite

 ...

 # pass the PublishMode to the publish workbooks method
 new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true)

ServerInfoItem class

ServerInfoItem(product_version, build_number, rest_api_version)

The ServerInfoItem class contains the build and version information for Tableau Server. The server information is accessed with the server_info.get() method, which returns an instance of the ServerInfo class.

Attributes

ServerInfo methods

The TSC library provides a method to access the build and version information from Tableau Server.

server_info.get

server_info.get()

Retrieve the build and version information for the server.

This method makes an unauthenticated call, so no sign in or authentication token is required.

REST API: Server Info

Parameters None

Exceptions

Example

import tableauserverclient as TSC

# create a instance of server
server = TSC.Server('https://MY-SERVER')

# set the version number > 2.3
# the server_info.get() method works in 2.4 and later
server.version = '2.5'

s_info = server.server_info.get()
print("\nServer info:")
print("\tProduct version: {0}".format(s_info.product_version))
print("\tREST API version: {0}".format(s_info.rest_api_version))
print("\tBuild number: {0}".format(s_info.build_number))

Sites

Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server.

The site resources for Tableau Server and Tableau Cloud are defined in the SiteItem class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the SiteItem class.

SiteItem class

SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None,
                 disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False)

The SiteItem class contains the members or attributes for the site resources on Tableau Server or Tableau Cloud. The SiteItem class defines the information you can request or query from Tableau Server or Tableau Cloud. The class members correspond to the attributes of a server request or response payload.

Attributes

Example

# create a new instance of a SiteItem

new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='ContentAndUsers', user_quota=15, storage_quota=1000, disable_subscriptions=True)

Source file: models/site_item.py

Site methods

The TSC library provides methods that operate on sites for Tableau Server and Tableau Cloud. These methods correspond to endpoints or methods for sites in the Tableau REST API.

Source file: server/endpoint/sites_endpoint.py

sites.create

sites.create(site_item)

Creates a new site on the server for the specified site item object.

Tableau Server only.

REST API: Create Site

Parameters

Returns

Returns a new instance of SiteItem.

Example

import tableauserverclient as TSC

# create an instance of server
server = TSC.Server('https://MY-SERVER')

# create shortcut for admin mode
content_users=TSC.SiteItem.AdminMode.ContentAndUsers

# create a new SiteItem
new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True)

# call the sites create method with the SiteItem
new_site = server.sites.create(new_site)

sites.get

sites.get()

Queries all the sites on the server.

REST API: Query Sites

Parameters

None.

Returns

Returns a list of all SiteItem objects and a PaginationItem. Use these values to iterate through the results.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc.

  # query the sites
  all_sites, pagination_item = server.sites.get()

  # print all the site names and ids
  for site in all_sites:
       print(site.id, site.name, site.content_url, site.state)

sites.get_by_id

sites.get_by_id(site_id)

Queries the site with the given ID.

REST API: Query Site

Parameters

Exceptions

Returns

Returns the SiteItem.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc.

 a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d')
 print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name))

sites.get_by_name

sites.get_by_name(site_name)

Queries the site with the specified name.

REST API: Query Site

Parameters

Exceptions

Returns

Returns the SiteItem.

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc.

 a_site = server.sites.get_by_name('MY_SITE')

sites.update

sites.update(site_item)

Modifies the settings for site.

The site item object must include the site ID and overrides all other settings.

REST API: Update Site

Parameters

Exceptions

Returns

Returns the updated site_item.

Example

...

# make some updates to an existing site_item
site_item.name ="New name"

# call update
site_item = server.sites.update(site_item)

...

sites.delete

Sites.delete(site_id)

Deletes the specified site.

REST API: Delete Site

Parameters

Exceptions

Example

# import tableauserverclient as TSC
# server = TSC.Server('https://MY-SERVER')
# sign in, etc.

server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d')

Sort

The Sort class is used with request options (RequestOptions) where you can filter and sort on the results returned from the server.

You can use the sort and request options to filter and sort the following endpoints:

• Users
• Datasources
• Workbooks
• Views

Sort class

sort(field, direction)

Attributes

Example

# create a new instance of a request option object
req_option = TSC.RequestOptions()

# add the sort expression, sorting by name and direction
req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name,
                             TSC.RequestOptions.Direction.Asc))
matching_workbooks, pagination_item = server.workbooks.get(req_option)

for wb in matching_workbooks:
    print(wb.name)

For information about using the Sort class, see Filter and Sort.

Subscriptions

Using the TSC library, you can manage subscriptions to views or workbooks on a site. You can get information about all the subscriptions on a site, or information about a specific subscription on a site, and you can create, update, or delete subscriptions.

SubscriptionItem class

The subscription resources for Tableau Server are defined in the SubscriptionItem class. The class corresponds to the subscription resources you can access using the Tableau Server REST API. The subscription methods are based upon the endpoints for subscriptions in the REST API and operate on the SubscriptionItem class.

SubscriptionItem(subject, schedule_id, user_id, target)

Attributes

Valid PDF options (applies only if attach_pdf is set to True)

Source files: server/endpoints/subscription_item.py server/request_options.py

Subscription methods

The Tableau Server Client provides several methods for interacting with subscription resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API.

Source files: server/endpoints/subscriptions_endpoint.py

subscription.create

subscription.create(subscription_item)

Creates a subscription to a view or workbook for a specific user on a specific schedule. When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that’s defined on Tableau Server and specified in the subscription_item.

To create a new subscription you need to first create a new subscription_item (from SubscriptionItem class).

REST API: Create Subscription

Parameters

Returns

Returns the new SubscriptionItem object.

Example

# Create the target (content) of the subscription with its ID and type.
# ID can be obtained by calling workbooks.get() or views.get().
target = TSC.Target('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook')

# Store the schedule ID and user ID.
# IDs can be obtained by calling schedules.get() and users.get().
schedule_id = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1'
user_id = '28ce5884-ed38-49a9-aa10-8f5fbd59bbf6'

# Create the new SubscriptionItem object with variables from above.
new_sub = TSC.SubscriptionItem('My Subscription', schedule_id, user_id, target)

# (Optional) Set other fields. Any of these can be added or removed.
new_sub.attach_image = False
new_sub.attach_pdf = True
new_sub.message = "You have an alert!"
new_sub.page_orientation = TSC.PDFRequestOptions.Orientation.Landscape
new_sub.page_size_option = TSC.PDFRequestOptions.PageType.B4
new_sub.send_if_view_empty = True

# Create the new subscription on the site you are logged in.
new_sub = server.subscriptions.create(new_sub)
print(new_sub.subject)

subscriptions.delete

subscriptions.delete(subscription_id)

Deletes the specified subscription from the site.

REST API: Delete Subscription

Parameters

Exceptions

Example

#  Remove a subscription from the site

#  import tableauserverclient as TSC
#  tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE')
#  server = TSC.Server('https://SERVERURL')


   with server.auth.sign_in(tableau_auth):
     server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d')

subscription.get

subscription.get(req_options=None)

Returns information about the subscriptions on the specified site.

REST API: Query Subscriptions

Parameters