Skip to main content

Get Active Dialogs

Available November 2026 and later.

Lists the current actionable dialogs in the connected Tableau Studio instance, including each dialog's exact identity, visible message and diagnostic text, and invokable actions. Text buttons retain their exact labels; recognized unlabeled controls use semantic actions such as close. Self-clearing progress windows are excluded, and an empty dialogs array means no dialog needs a decision. This is a read-only, idempotent inspection.

APIs called​

This tool reads from the local Tableau Studio instance, not from 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> over the loopback interface, 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.

  • Lists the current visible modal dialogs that need a decision, with each dialog's exact identity and invokable actions. Authorized by the session's loopback bearer token.
    • GET /v<x>/app/dialogs — list the current actionable dialogs. API reference

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 or a session has been pinned).

Example​

"studio-1"

Notes and caveats​

  • Identity is always present; content is best-effort. Every dialog includes objectName, title, and className. messageText, informativeText, detailedText, detailedTextTruncated, iconLevel, buttons, and actions appear only when the running instance reports them. Standard message boxes expose those fields precisely; generic dialogs may omit them or include incidental labels.
  • Diagnostic text is capped. detailedText is limited to 1 MiB. When it is shortened, detailedTextTruncated is true.
  • Copy objectName, title, className, and an actions entry verbatim into invoke-dialog-action. Do not reconstruct a label from buttons or invent a close.

Example results​

Dialogs that need a decision​

{
"dialogs": [
{
"objectName": "saveChangesDialog",
"title": "Save Changes",
"className": "QMessageBox",
"messageText": "Do you want to save changes to Regional Sales?",
"informativeText": "Unsaved changes will be lost if you discard them.",
"detailedText": "Workbook: Regional Sales",
"iconLevel": "warning",
"buttons": ["Save", "Discard", "Cancel"],
"actions": [
{ "kind": "button", "label": "Save" },
{ "kind": "button", "label": "Discard" },
{ "kind": "button", "label": "Cancel" }
]
}
]
}

No dialog needs a decision​

{
"dialogs": []
}