Build from codeReport representation example library (Beta)

Example representation: Report with a header (Beta)

View as Markdown

This documentation describes one or more public 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.

This is an example representation of a report, retrieved using the Get a report endpoint with the query parameter includeContents=true. Representations like this one can be used to create a report from code using the Create a report endpoint. Each page in this example library includes the code representation of the report and step-by-step instructions to create it in the Sigma UI.

Consult this example and others in the Report 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 reports 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 reports from code.

System and user requirements

To complete the steps in this example, you must meet the user requirements listed below for creating the report in the UI and creating it from code.

The ability to create this report in the Sigma UI requires the following:

  • You must be assigned an account type with the Create, edit, and publish reports permission enabled.
  • You must have access to a connection to a data platform.

The ability to create a report from code requires the following:

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 report in the Sigma UI

This example shows a report with a header.

To create this report in the Sigma UI:

  1. Go to the Home page.

  2. Select Create new > Report.

    A new report opens.

  3. In the Header section, next to Manage page headers, select Add new header.

  4. Double-click the header name and rename it Gray Header.

  5. In the Height field, enter 80.

  6. In the Background color field, enter #B4B4B4.

  7. Add a text element to the header:

    1. In the add element bar, select UI > Text.
    2. In the text element, enter Marketing Report.
    3. Drag the text element to the center of the header.

  8. In the document header, select Save as.

  9. Enter a name for the report, such as header.

  10. Select Save.

Get a code representation of this report

To get a representation of this report, follow the steps in Get the code representation of a report.

The code representation of this report appears like the following:

reportId: fd6a931b-eb70-4044-b0a4-2615f0555f5a
reportUrlId: cf8NSBakvGqI3xXWIKFkHX
createdBy: UWCrlXH5OZPIvkmpaeAMF2oY3Y2dQ
updatedBy: wAj3rAPRQ7VNx4vU2IaXXBv0x6YEk
createdAt: '2026-07-24T20:21:55.688Z'
updatedAt: '2026-07-24T20:30:07.189Z'
name: header
url: https://aws-api.sigmacomputing.com/org-name/report/cf8NSBakvGqI3xXWIKFkHX
path: My Documents/<folder-name>
latestVersion: 2
ownerId: UWCrlXH5OZPIvkmpaeAMF2oY3Y2dQ
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: BsLKCsHcVT
      kind: text
      body: 'Marketing Report '
  pages:
    - id: QOyG6NX3UD
      name: Page 1
  panels:
    - id: yPz0vwuZ3g
      type: header
      title: Gray Header
      config:
        height: 80
        backgroundColor: '#B4B4B4'
      pages:
        - QOyG6NX3UD
  config:
    margin: 0
    pageHeight: 1056
    pageWidth: 816
  kind: report
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page id="QOyG6NX3UD"/>
    <Panel id="yPz0vwuZ3g" type="header">
      <Element elementId="BsLKCsHcVT" x="345" y="30" width="126" height="24"/>
    </Panel>
documentVersion: 2

Representing headers

...
panels:
- id: yPz0vwuZ3g
  type: header
  title: Gray Header
  config:
    height: 80
    backgroundColor: '#B4B4B4'
  pages:
  - QOyG6NX3UD
...