Example representation: Workbook with an unnested array
This is an example representation of a workbook, retrieved using the Get a workbook endpoint with the query parameter includeContents=true. Representations like this one can be used to create a workbook from code using the Create a workbook endpoint. Each page in this example library includes the code representation of the workbook and step-by-step instructions to create it in the Sigma UI.
Consult this example and others in the Workbook representation example library to:
- Troubleshoot the formatting of a particular feature in code representation
- Relate a feature from the Sigma UI to its representation in code
- Provide context to AI tools used to create workbooks from code
This example representation cannot be used as-is. All identifying details, such as IDs, names, and URLs, have been replaced with randomized ID values or generic substitutions. The format of these contents, like the length of ID values, is preserved for demonstrative purposes. However, this representation cannot be directly used without modification to the base URL, connection details, and more. For more information, see Create and manage workbooks from code.
System and user requirements
To complete the steps in this example, you must meet the user requirements listed below for creating the workbook in the UI and creating it from code.
The ability to create this workbook in the Sigma UI requires the following:
- You must be assigned an account type with the Create input tables and Create, edit, and publish workbooks permissions enabled.
- You must have Can write only or Can use data access on a connection with write access enabled.
The ability to create a workbook from code requires the following:
- You must be assigned an account type with the Create, edit, and publish workbooks permission enabled.
- You must have developer credentials for the Sigma API. For more information, see Get started with the Sigma REST API.
Create the example workbook in the Sigma UI
This example shows a workbook with an input table containing an array and a table that unnests the array into rows.
To create this workbook in the Sigma UI:
- Go to the Home page.
- Select Create new > Workbook.
- From the Add element bar, select Input > Empty input table.
- In the Select connection dropdown, select a connection with write access, then select Create table.
- In the input table, create a calculated column named
Arraywith the formulaArray(1, 2, 3). - From the Add element bar, select Table > Data > Unnest.
- In the Select source modal, select the input table, then click Select.
- In the Unnest table modal, select Array as the Array column and enter
Valuesas the Values column label. - Turn on the Include index column toggle and enter
Indices of Arrayas the Index column label. - Under Output columns, select Values and Indices of Array, then select Submit.
- In the document header, select Save as.
- Enter a name for the workbook, such as
unnest. - Select Save.
Get a code representation of this workbook
To get a representation of this workbook, follow the steps in Get the code representation of a workbook.
The code representation of this workbook appears like the following:

