Workbook representation example library (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.
The Sigma programmatic API endpoints, including Create a workbook from a code representation, Update a workbook from a code representation, and Get the code representation of a workbook require a specific format for the representation of the workbook. This example library shows examples of workbook representations for various configurations, using different element types and features in Sigma.
Consult these examples to:
- Troubleshoot the formatting of a particular feature in a code representation
- Relate a feature from the Sigma UI to its representation in code
- Provide context to AI assistants used to create workbooks from code
Example representations
To review a specific representation, search or browse the following examples:
| Feature | Link |
|---|---|
| Workbook with a table | View example |
| Workbook with a bar chart | View example |
| Workbook with a line chart | View example |
| Workbook with a KPI | View example |
| Workbook with a pie chart | View example |
| Workbook with a donut chart | View example |
To see the representation for a specific configuration or combination of features, you can create the workbook in the UI and then retrieve the representation using the Get the code representation of a workbook endpoint.