Skip to main content

Get Workbook Diagnostics

Available November 2026 and later.

Inspect the existing workbook before editing. Use diagnostics returned by supported workbook and worksheet document edits instead of a second read for the same result. Static diagnostics do not verify query execution or rendering.

APIs called​

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

  • Inspect the existing workbook before editing.

Optional arguments​

session​

Session ID; optional if pinned or unique.

worksheetName​

Worksheet name or stable id; omit for diagnostics for the entire workbook.