Unable to Use Refresh Parameter in Tableau Cloud Embedding API 3.0

KNOWLEDGE BASE

Unable to Use Refresh Parameter in Tableau Cloud Embedding API 3.0

Published: 19 Jan 2023
Last Modified Date: 20 Jan 2023

Issue

When using the new Embedding API 3.0 with Tableau Cloud, you are unable to refresh the view on load using a parameter within the embed code without having to press the dashboard refresh button.

Environment

Tableau Cloud
Embedding API 3.0

Resolution

As a potential workaround, you can utilize a custom parameter to set :refresh = yes using the code below.

<tableau-viz id="tableauViz">
<custom-parameter name=":refresh" value="yes"></custom-parameter>
</tableau-viz>

For more information on custom parameters, please see Custom Parameters.

Cause

Currently, the ability to use the refresh parameter in embed code for the embedding API 3.0 is not built into the product.

Additional Information

The refresh parameter in older versions of the API would be as follows:
- <param name='refreshDataAsync' value='yes' />

Please note this parameter above will not work in the latest version of the embedding API 3.0. Utilize the custom parameter under the resolution section.