Skip to navigation

Report representation example library

View as Markdown

The Sigma programmatic API endpoints, including Create a report, Update a report from a code representation, and Get a report, require a specific format for the representation of the report. This example library shows examples of report 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 reports from code

Example representations

Report-only representations

Search or browse the following examples for report feature representations:

Link
Basic report exampleView example
Report with a headerView example
Report with a footerView example
Report with a page marginView example
Report with a page numberView example
Report with a paginated tableView example
Report with element layeringView example
Report with a repeated containerView example

Shared workbook and report representations

Workbooks and reports share the way many elements and features, such as tables and charts, are represented in code. You can view the examples for these features in the Workbook representation example library.

Only features that are supported in the report UI are available in the code representation. For more information on unsupported features, see Limitations.

At the bottom of each workbook example is a feature-specific snippet that you can use in a report. For example, see the Representing area charts snippet. Add this snippet to the report’s contents.elements array, then place the element in the contents.layout.

To see the representation for a specific configuration or combination of features, you can create the report in the UI and then retrieve the representation using the Get a report endpoint with includeContents=true.