Set Start Page Visibility
Shows or hides the Tableau Studio Start Page and returns the actual resulting visibility. The value in the result is what Tableau Studio reports after the call, which can differ from the requested isStartPageVisible.
APIs called
This tool acts on the running Tableau Studio instance, not on the Tableau Cloud or Tableau Server REST API. Under the hood this is a call to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x>, where <x> is the latest API version. There are no OAuth scopes: the call is authorized by the running Tableau Studio instance's per-session bearer token over the loopback interface.
- Settles on which Tableau Studio session to target before anything is sent. Resolved in-process (not an API call).
- Asks Tableau Studio to show or hide the Start Page. Requires a connected Tableau Studio session; authorized by that session's loopback bearer token. The JSON body is
{ "isStartPageVisible": <boolean> }.POST /v<x>/app:toggleStartPage— set Start Page visibility. API reference
Required arguments
isStartPageVisible
Whether the Tableau Studio Start Page should be visible. Type: boolean. Pass true to show it and false to hide it. The result's isStartPageVisible is the visibility Tableau Studio actually reports after the call, not a copy of this request value.
Example
{ "isStartPageVisible": false }
If Tableau Studio returns a different visibility than you asked for, the tool reports that actual value (and a matching message) rather than echoing the request.
Optional arguments
session
Identifier of the target Tableau Studio session. When omitted, the session is resolved automatically (for example, when exactly one Tableau Studio instance is connected).
Example
"studio-1"
With no session given and no Tableau Studio instance running, or more than one running, the tool reports an error rather than picking one; the multiple-instance error lists the session IDs to choose from. A session that names an instance which is not among the running ones is refused the same way.
Notes and caveats
- Not read-only, but idempotent. The tool changes Start Page visibility, so it is not a read-only operation; however, asking for a visibility the Start Page already has is safe to repeat.
- The
messagefield still names the product "Tableau Desktop", as shown in the examples below. That is the literal text the tool returns today and is reproduced here verbatim; read it as Tableau Studio.
Example results
Start Page hidden
{
"isStartPageVisible": false,
"message": "The Tableau Desktop Start Page is hidden."
}
Start Page shown
{
"isStartPageVisible": true,
"message": "The Tableau Desktop Start Page is visible."
}
Requested visible, actual hidden
{
"isStartPageVisible": false,
"message": "The Tableau Desktop Start Page is hidden."
}
Related
get-app-info— reads application information for the running instance, including whether the Start Page is currently visible.list-instances— lists running Tableau Studio sessions so you can pass asessionwhen more than one instance is connected.