Tableau REST API Help

Sever administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server precomputes the workbook's data in a background process.

Notes:

• This topic explains how to configure data acceleration using the Tableau Server REST API. However, the easiest way to configure data acceleration is to use the accelerate_workbooks.py Python script that you can download from the Tableau Data Acceleration Client(Link opens in a new window) GitHub repository.
• Data acceleration is not available for Tableau Cloud.

For more information about this capability, see Data Acceleration in the Tableau Server Help.

Configure data acceleration

To configure data acceleration using the REST API, do the following:

• Update a workbook to turn on or off data acceleration by setting the attribute accelerationEnabled to true or false. By default, it is disabled. You can also set the accelerateNow attribute to true or false to specify whether to start the precomputation for acceleration immediately when the next backgrounder process becomes available.
• Create a schedule of type DataAcceleration
• Add a workbook with data acceleration to the schedule
• Get data acceleration tasks
• Delete a data acceleration task
• Get a data acceleration report for a site

Additional notes about data acceleration

• To remove a workbook from a schedule, update the workbook to turn off data acceleration by setting the attribute accelerationEnabled to false.

• Data acceleration is turned on by default for sites. You can update a site to enable or disable data acceleration by setting the attribute dataAccelerationMode to enable_selective or disable. When you disable it, no workbooks are accelerated and all data acceleration tasks are removed from schedules.

• When you create a schedule, consider setting the schedule interval to be less than 12 hours. When you attach an acceleration schedule to a workbook, if that acceleration schedule interval exceeds the Tableau Server cache expiration time, the workbook will not be accelerated during the period between the cache expiration time and the next run of the acceleration schedule.  The workbook will revert to using the databases. By default, the Tableau Server cache expiration time is 12 hours (720 minutes).