Example representation: Workbook with a table (Beta)

🚩
This documentation describes one or more private beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.
This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.
If you are interested in joining a limited test group and enabling this feature in your Sigma organization, contact Support or reach out to your Account Executive.

This is an example representation of a workbook, created using the get a workbook representation endpoint. Representations like this one can be used to create a workbook from code using the create a workbook from a representation 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, edit, and publish workbooks permission enabled.
You must have access to a connection to a data platform.

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.

This example uses a table from the Sigma Sample Connection. Your organization might have disabled access to the Sigma sample connection. If so, you can contact an admin to enable it, or use a table from another connection to follow along with this example.

Create the example workbook in the Sigma UI

This example shows a simple workbook with a single table element, sourced from a warehouse table.

To create this workbook in the Sigma UI:

Go to the Home page.
Select Create new > Workbook.

A new workbook opens.
From the Add element bar, select Data > Table.
In the Select source modal, search for the table TRIPS in the EXAMPLES.BIKES schema.
Select the table to add it to the workbook.

The table appears in the workbook.
In the document header, select Save as.
Enter a name for the workbook.
Select Save.

Get a code representation of this workbook

YAML representation

workbookId: 3ee4e577-757a-49d2-b077-57741a373285
name: table
url: https://aws-api.sigmacomputing.com/org-name/workbook/table-JjtuSwuoOReVVwk04uD1WF
documentVersion: 1
latestDocumentVersion: 1
ownerId: Ipb0LILcSmxdd6uZFfy2EJLR6N2nr
folderId: 2cfd0815-2749-49b4-9a07-46684d13e7d0
createdBy: Ipb0LILcSmxdd6uZFfy2EJLR6N2nr
updatedBy: Ipb0LILcSmxdd6uZFfy2EJLR6N2nr
createdAt: '2026-04-20T20:09:51.815Z'
updatedAt: '2026-04-20T20:09:51.815Z'
schemaVersion: 1
pages:
  - id: Ce7Jmi42Z8
    name: Page 1
    elements:
      - id: n7DqXr54CY
        kind: table
        source:
          connectionId: d6bfeea1-5da2-458c-9bcf-ec9400d24ceb
          kind: warehouse-table
          path:
            - FUN
            - BIKES
            - TRIP
        columns:
          - id: Kc2wRqr9AM
            formula: '[TRIP/Id]'
          - id: OUfVeWtol6
            formula: '[TRIP/Duration]'
          - id: 3WGNOoCuRk
            formula: '[TRIP/Start Date]'
          - id: OL5FiZbf9R
            formula: '[TRIP/Start Station Name]'
          - id: mcRQvHSX8W
            formula: '[TRIP/Start Station Id]'
          - id: gBuJSGaS7u
            formula: '[TRIP/End Date]'
          - id: DDl9tS9exf
            formula: '[TRIP/End Station Name]'
          - id: qFZDYWH9UV
            formula: '[TRIP/End Station Id]'
          - id: b9Z52OGaJH
            formula: '[TRIP/Bike Id]'
          - id: YtjzMkzBzB
            formula: '[TRIP/Subscription Type]'
          - id: pqotLuvxde
            formula: '[TRIP/Zip Code]'
        order:
          - Kc2wRqr9AM
          - OUfVeWtol6
          - 3WGNOoCuRk
          - OL5FiZbf9R
          - mcRQvHSX8W
          - gBuJSGaS7u
          - DDl9tS9exf
          - qFZDYWH9UV
          - b9Z52OGaJH
          - YtjzMkzBzB
          - pqotLuvxde
layout: |
  <?xml version="1.0" encoding="utf-8"?>
  <Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="Ce7Jmi42Z8">
    <LayoutElement elementId="n7DqXr54CY" gridColumn="1 / 25" gridRow="1 / 21"/>
  </Page>

Representing tables

Table representation

...
id: n7DqXr54CY
kind: table
source:
  connectionId: d6bfeea1-5da2-458c-9bcf-ec9400d24ceb
  kind: warehouse-table
  path:
  - FUN
  - BIKES
  - TRIP
columns:
- id: Kc2wRqr9AM
  formula: '[TRIP/Id]'
- id: OUfVeWtol6
  formula: '[TRIP/Duration]'
- id: 3WGNOoCuRk
  formula: '[TRIP/Start Date]'
- id: OL5FiZbf9R
  formula: '[TRIP/Start Station Name]'
- id: mcRQvHSX8W
  formula: '[TRIP/Start Station Id]'
- id: gBuJSGaS7u
  formula: '[TRIP/End Date]'
- id: DDl9tS9exf
  formula: '[TRIP/End Station Name]'
- id: qFZDYWH9UV
  formula: '[TRIP/End Station Id]'
- id: b9Z52OGaJH
  formula: '[TRIP/Bike Id]'
- id: YtjzMkzBzB
  formula: '[TRIP/Subscription Type]'
- id: pqotLuvxde
  formula: '[TRIP/Zip Code]'
order:
- Kc2wRqr9AM
- OUfVeWtol6
- 3WGNOoCuRk
- OL5FiZbf9R
- mcRQvHSX8W
- gBuJSGaS7u
- DDl9tS9exf
- qFZDYWH9UV
- b9Z52OGaJH
- YtjzMkzBzB
- pqotLuvxde
...