Skip to navigation

Example representation: Workbook with a transposed table

View as Markdown

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, 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:

Create the example workbook in the Sigma UI

This example shows a workbook with a table created by transposing columns into rows.

To create this workbook in the Sigma UI:

  1. Go to the Home page.

  2. Select Create new > Workbook.

  3. From the Add element bar, select Data > Table.

  4. In the Select source modal, select Transpose.

  5. Search for and select the FIVETRAN_LOG__AUDIT_TABLE table in the APPLICATIONS.FIVETRAN_LOG schema.

  6. In the Transpose table modal, configure the following settings:

    OptionSetting
    TypeColumn to row
    Columns to mergeWrite to Table Start, Write to Table End, Sync Start, and Sync End
    Column label for merged columnsEvent Type
    Column label for valuesTimestamp
  7. Select Submit.

  8. In the document header, select Save as.

  9. Enter a name for the workbook, such as transpose.

  10. 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:

workbookId: 4dad2986-ce83-4960-aa06-e9ab85a0bcc1
workbookUrlId: 9xslXTTIQrh6bpy0VAq3GZ
createdBy: uO2R8UziJdi0Y4mj4TIJZ9RnvIh4T
updatedBy: uO2R8UziJdi0Y4mj4TIJZ9RnvIh4T
createdAt: '2026-09-01T14:58:01.033Z'
updatedAt: '2026-11-03T20:23:58.993Z'
name: transpose
url: https://aws-api.sigmacomputing.com/org-name/workbook/9xslXTTIQrh6bpy0VAq3GZ
path: My Documents/<folder-name>
latestVersion: 2
ownerId: uO2R8UziJdi0Y4mj4TIJZ9RnvIh4T
isArchived: false
contents:
schemaVersion: 1
elements:
- id: OetAfG82EO
kind: table
source:
kind: transpose
source:
connectionId: aebf9993-2440-4d96-9995-d8aaff0f3b81
kind: warehouse-table
path:
- APPLICATIONS
- FIVETRAN_LOG
- FIVETRAN_LOG__AUDIT_TABLE
direction: column-to-row
columnsToMerge:
- Write to Table Start
- Write to Table End
- Sync Start
- Sync End
columnLabelForMergedColumns: Event Type
columnLabelForValues: Timestamp
columns:
- id: ZA0G6vbBxK
formula: '[Transpose of FIVETRAN_LOG__AUDIT_TABLE/Unique Table Sync Key]'
- id: d5WVwd9ExL
formula: '[Transpose of FIVETRAN_LOG__AUDIT_TABLE/Event Type]'
- id: Xa3zphJn9p
formula: '[Transpose of FIVETRAN_LOG__AUDIT_TABLE/Timestamp]'
order:
- ZA0G6vbBxK
- d5WVwd9ExL
- Xa3zphJn9p
pages:
- id: H9xdreYrmV
name: Page 1
kind: workbook
layout: |
<?xml version="1.0" encoding="utf-8"?>
<Page type="grid" gridTemplateColumns="repeat(24, 1fr)" gridTemplateRows="auto" id="H9xdreYrmV">
<Element elementId="OetAfG82EO" gridColumn="1 / 25" gridRow="1 / 22"/>
</Page>
documentVersion: 2

Representing transposed tables

...
id: OetAfG82EO
kind: table
source:
kind: transpose
source:
connectionId: aebf9993-2440-4d96-9995-d8aaff0f3b81
kind: warehouse-table
path:
- APPLICATIONS
- FIVETRAN_LOG
- FIVETRAN_LOG__AUDIT_TABLE
direction: column-to-row
columnsToMerge:
- Write to Table Start
- Write to Table End
- Sync Start
- Sync End
columnLabelForMergedColumns: Event Type
columnLabelForValues: Timestamp
columns:
- id: ZA0G6vbBxK
formula: '[Transpose of FIVETRAN_LOG__AUDIT_TABLE/Unique Table Sync Key]'
- id: d5WVwd9ExL
formula: '[Transpose of FIVETRAN_LOG__AUDIT_TABLE/Event Type]'
- id: Xa3zphJn9p
formula: '[Transpose of FIVETRAN_LOG__AUDIT_TABLE/Timestamp]'
order:
- ZA0G6vbBxK
- d5WVwd9ExL
- Xa3zphJn9p
...