Get Sheets
Read the sheets in the open workbook.
- Omit
kindto get the workbook title, whether it has unsaved changes, and every sheet. - Pass
kindalone to list that kind's sheets, each withid,name, andstate. - Pass
kindandsheetIdto read that one sheet.
index is the 0-based tab position across all kinds, not the order of one kind's list. A worksheet's datasource list contains its references. An empty list does not mean the workbook has no connected datasource. Use get-datasources when connection inventory matters. This tool is not needed before template discovery or building.
APIs called
This tool reads the workbook open in the running Tableau Studio instance through the local Tableau Studio External Client API. There are no OAuth scopes.
- With no
kind, reads the workbook inventory: title, unsaved changes, and every sheet. - With
kindand nosheetId, lists worksheets, dashboards, or storyboards. - With
kindandsheetId, resolves the name or id and reads that sheet.
Optional arguments
session
Session ID. Optional when a session is pinned or only one Tableau Studio instance is connected.
Example
"studio-1"
kind
Kind to list or read. Omit it to return every sheet. One of worksheet, dashboard, or storyboard.
Example
"worksheet"
kind is required when sheetId is set. The tool refuses with kind is required with sheetId.
sheetId
Id of one sheet to read. A unique sheet name also works. Requires kind. Omit it to list that kind.
Example
"Sales by Region"
Notes and caveats
- Every sheet includes
idandname. Other fields appear only when the running Tableau Studio instance reports them. A fallback read may recover only id and name. - When the workbook has no sheets of a kind, that list is an empty array.
- Pass
idrather thannamewhen two sheets share a display name.indexis the tab position across every kind, not the order of one kind's list. - This read does not return a sheet's structure. Use
get-xmlfor that.
Related
get-datasources— lists workbook datasources, including ones no sheet uses.get-xml— reads the live structure of the workbook or one existing sheet.