Build from codeReport representation example library (Beta)

Example representation: Basic report example (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 basic report with the following elements and features:

  • Header
  • Text element
  • Table
  • Bar chart

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 Bike Report Header.

  5. In the Height field, enter 70.

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

  7. Add a text element to the header:

    1. In the add element bar, select UI > Text.
    2. In the text element, enter Bike Trips.
    3. Select the default Medium paragraph preset in the text style dropdown menu. Select and change it to Medium heading.
    4. Drag the text element to the center of the header.

  8. Add a text element to the body of the report:

    1. In the add element bar, select UI > Text.
    2. In the text element, enter This report provides information about bike trips starting from a variety of stations in California..
    3. Resize the text element to width of 650 pixels.
    4. Select Italic in the toolbar to italicize the text.
    5. Drag the text element to the following coordinates: x of 10, y of 10.

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

  10. In the Select source modal, search for the table TRIP in the EXAMPLES.BIKES schema.

  11. Select the table to add it to the workbook.

    The table appears in the workbook.

  12. Select Add child element > Chart.

    A new bar chart element appears on the workbook canvas.

  13. In the editor panel, select Properties and configure the bar chart with the following settings:

    OptionSetting
    X-axisStart Station Name
    Y-axisCount of Id

  14. Select the down arrow next to Start Station Name to open the column details menu and select Sort > Start Station Name.

  15. Arrange the table and bar chart for better readability. Reposition and resize the elements to the following specifications:

  • TRIP table: x of 0, y of 55, width of 816, height of 280.
  • Bar chart: x of 0, y of 369, width of 816, height of 365.
  1. In the document header, select Save as.
  2. Enter a name for the report, such as basic-report.
  3. 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: 56852fb3-a575-4caa-9ead-8c16f7e82078
reportUrlId: ocWwmnBNUwDKOERoHNJ5S
createdBy: UWCrlXH5OZPIvkmpaeAMF2oY3Y2dQ
updatedBy: wAj3rAPRQ7VNx4vU2IaXXBv0x6YEk
createdAt: '2026-08-02T02:45:29.216Z'
updatedAt: '2026-09-16T16:40:50.115Z'
name: basic-report
url: https://aws-api.sigmacomputing.com/org-name/report/ocWwmnBNUwDKOERoHNJ5S
path: My Documents/<folder-name>
latestVersion: 2
ownerId: ARJP0PfYGH2x6zt5UV2XwVqGJnYeQ
isArchived: false
contents:
  schemaVersion: 1
  elements:
    - id: QXypgh5epY
      kind: text
      body: '*This report provides information about bike trips starting from a variety of stations in California.*'
    - id: H9TdEAGSd2
      kind: table
      source:
        connectionId: 260797d8-7d5c-4ef2-8b11-18aee5513a25
        kind: warehouse-table
        path:
          - EXAMPLES
          - BIKES
          - TRIP
      columns:
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/ID
          formula: '[TRIP/Id]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/DURATION
          formula: '[TRIP/Duration]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/START_DATE
          formula: '[TRIP/Start Date]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/START_STATION_NAME
          formula: '[TRIP/Start Station Name]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/START_STATION_ID
          formula: '[TRIP/Start Station Id]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/END_DATE
          formula: '[TRIP/End Date]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/END_STATION_NAME
          formula: '[TRIP/End Station Name]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/END_STATION_ID
          formula: '[TRIP/End Station Id]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/BIKE_ID
          formula: '[TRIP/Bike Id]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/SUBSCRIPTION_TYPE
          formula: '[TRIP/Subscription Type]'
        - id: inode-Lo4GKgFOEBu27r7HW3Am7D/ZIP_CODE
          formula: '[TRIP/Zip Code]'
      order:
        - inode-Lo4GKgFOEBu27r7HW3Am7D/ID
        - inode-Lo4GKgFOEBu27r7HW3Am7D/DURATION
        - inode-Lo4GKgFOEBu27r7HW3Am7D/START_DATE
        - inode-Lo4GKgFOEBu27r7HW3Am7D/START_STATION_NAME
        - inode-Lo4GKgFOEBu27r7HW3Am7D/START_STATION_ID
        - inode-Lo4GKgFOEBu27r7HW3Am7D/END_DATE
        - inode-Lo4GKgFOEBu27r7HW3Am7D/END_STATION_NAME
        - inode-Lo4GKgFOEBu27r7HW3Am7D/END_STATION_ID
        - inode-Lo4GKgFOEBu27r7HW3Am7D/BIKE_ID
        - inode-Lo4GKgFOEBu27r7HW3Am7D/SUBSCRIPTION_TYPE
        - inode-Lo4GKgFOEBu27r7HW3Am7D/ZIP_CODE
    - id: T3h67webxe
      kind: bar-chart
      source:
        elementId: H9TdEAGSd2
        kind: table
      columns:
        - id: ZhYfwOCr30
          formula: '[TRIP/Start Station Name]'
        - id: pguie8ddq7
          formula: Count([Id])
        - id: JEGFDf7rh6
          formula: '[TRIP/Id]'
        - id: oUr0kYueyJ
          formula: '[TRIP/Duration]'
        - id: EHxnLdOaEG
          formula: '[TRIP/Start Date]'
        - id: 1HeJaa4bvY
          formula: '[TRIP/Start Station Id]'
        - id: qYkcLDyzY9
          formula: '[TRIP/End Date]'
        - id: 7lm2wkhz1h
          formula: '[TRIP/End Station Name]'
        - id: Jd8soktvag
          formula: '[TRIP/End Station Id]'
        - id: xpQ5koTCAN
          formula: '[TRIP/Bike Id]'
        - id: Ds9JRYTaKw
          formula: '[TRIP/Subscription Type]'
        - id: 1E08nv02TI
          formula: '[TRIP/Zip Code]'
      yAxis:
        columnIds:
          - pguie8ddq7
      xAxis:
        columnId: ZhYfwOCr30
        sort:
          direction: descending
    - id: 9xIHZa8jXP
      kind: text
      body: '## Bike Trips'
  pages:
    - id: U5Vn1OjlY2
      name: Page 1
  panels:
    - id: NLXKP9pIFW
      type: header
      title: Header 1
      config:
        height: 70
        backgroundColor: '#A0CBE8'
      pages:
        - U5Vn1OjlY2
  config:
    margin: 0
    pageHeight: 1056
    pageWidth: 816
  kind: report
  layout: |
    <?xml version="1.0" encoding="utf-8"?>
    <Page id="U5Vn1OjlY2">
      <Element elementId="QXypgh5epY" x="10" y="10" width="650" height="100"/>
      <Element elementId="H9TdEAGSd2" x="0" y="55" width="816" height="280"/>
      <Element elementId="T3h67webxe" x="0" y="354" width="816" height="365"/>
    </Page>
    <Panel id="NLXKP9pIFW" type="header">
      <Element elementId="9xIHZa8jXP" x="332" y="11" width="152" height="49"/>
    </Panel>
documentVersion: 2