Skip to main content

Get Workbook State

Available November 2026 and later.

Report whether Tableau Studio is idle or blocked, the strongest observed blocking cause, all active native activities, UI snapshot completeness, and visible modal or progress window content. When a modal needs action, obtain fresh exact identity and actions from get-active-dialogs before considering invoke-dialog-action.

APIs called​

Talks to the open Tableau Studio workbook through the External Client API.

  • Report whether Tableau Studio is idle or blocked, the strongest observed blocking cause, all active native activities, UI snapshot completeness, and visible modal or progress window content.

Optional arguments​

session​

Session ID; optional if pinned or unique.