The List workbooks (GET /v2/workbooks) endpoint now includes the excludeExplorations query parameter to be used with the skipPermissionCheck query parameter to exclude explorations from the response.
For example, if an admin wants to return all workbooks in an organization, but exclude ad hoc explorations, they could send a GET request to https://api.sigmacomputing.com/v2/workbooks?skipPermissionCheck=true&excludeExplorations=true.
New filtering options for List connections and List user attributes endpoints
The following endpoints now support optional query parameters to allow you to filter the results:
The List connections (GET /v2/connections) endpoint now includes the search query parameter.
The List user attributes (GET /v2/user-attributes) endpoint now includes the name query parameter.
Workbook elements
Copy and paste container format
Copy the format of a container, then paste it to a destination container in any workbook. Select Copy/Paste > Copy format from the element menu, or use keyboard shortcuts ( ⌘+⌥+C to copy and ⌘+⌥+P to paste for Mac OS, or Ctrl+Alt+C to copy and Ctrl+Alt+P to paste for MS Windows).
Workbook features
Selection criteria for action conditions
When configuring a column condition on an action sequence, use the Selection matches criteria option to run the sequence only when a user selects a table, pivot table, or input table row containing a specific column value, or when the user selects a data point representing that value in a chart.
Dynamically move columns with actions
Use the Modify element > Move columns action to dynamically move columns into and out of groupings and properties when column names match selected control values in the trigger element. This action can be configured on List value and Segmented controls only.
Use different OAuth configurations for authenticating users to your connections than you use for your Sigma organization (Beta)
Sigma now supports authenticating a connection with OAuth without re-using OAuth credentials used for authenticating users to your Sigma organization. As a result:
You no longer need to use OAuth as your authentication method for your Sigma organization in order to authenticate a connection with OAuth.
If you use multiple IdPs and data platforms, you can create connections with different OAuth configurations as needed.
When authenticating Snowflake connections with OAuth, you can configure Proof Key for Code Exchange (PKCE) and/or JSON Web Tokens (JWTs) to secure your connection.
Modals help simplify workbook design and allow you to build a streamlined, app-like experience. An open modal overlays and obscures a workbook page to provide a focused view of the modal content. This reduces visual clutter and allows you to present form fields, provide customized drilldowns, display controls and filters in a dedicated container, etc.
Expanded options for the Add workbook schedule endpoint
The Add workbook schedule endpoint (POST /v2/workbooks/{workbookId}/schedules) now supports options that were previously available only from the UI, such as creating a conditional export, repeating pivot header labels, compressing attachments to a zip file, and specifying control values for the export.
Updated application of the On close action trigger for modals
The On close trigger type for modals has been updated to only initiate actions when a user clicks the Close icon or anywhere outside the modal. The trigger no longer applies when the Close modal action is configured for the primary or secondary button.
If you configured actions for the On close trigger that are intended to initiate when a user clicks a button to trigger a Close modal action, you can move the actions to the applicable button trigger.
Bug fixes
The Create connection endpoint (POST /v2/connections) and Update connection endpoint (PUT /v2/connections/{connectionId}) no longer fail when creating or updating connections with OAuth. Note that for non-OAuth connections, the API validates that you can connect to the newly created or updated connection with your credentials. In the case of an OAuth connection, this validation step does not apply. Instead, manually validate that you can connect with your OAuth credentials after you create or update the connection.
When the value of a grouping key is null, applying the Selection variable to an Open link action no longer returns a null value that opens a blank page.
Organizations hosted in AWS us-east-1 are now able to access the Sigma Audit Logs connection, which records data related to user-initiated events that occur within your Sigma organization. The connection is disabled by default, but an Admin user can enable it in the Administration portal.
The Swap workbook data sources endpoint (POST /v2/workbooks/{workbookId}/swapSources) now includes the option to swap dataset links. When using the sourceMapping option, the columnMapping option supports specifying a link name and linked column name to swap from one dataset link to another dataset link.
For example, to change the source for a workbook from one dataset link to another, set the fromId and toId to the same dataset ID, but update the fromColumn to the name of the previous dataset link and linked column name and the toColumn to the desired dataset link and linked column:
You can send a custom-filtered report to a dynamic list of recipients as a scheduled email burst. Send a workbook, workbook pages, and individual workbook elements as supported attachment types, such as PDF, Excel, or PNG files.
Set conditional exports to alert a specific number of times (Beta)
Limit the number of conditional exports by setting the frequency of an export to send only a given number of times per day, per week, or all time.
For example, a conditional export that sends an email when there is data in a table can be set to alert once per day.
Customize chart and formatting color scales (GA)
Create custom color scales to use when formatting chart colors or conditional formatting for tables. Create a custom color scale for an organization theme, workbook theme, or for a specific data element.
You can now set Australian English as your organization’s locale. Setting EN-AU as your organization’s locale will allow EN-AU number formatting, currency, and custom translations to be used as a default across the organization.
The Embed SDK for React offers a developer-friendly interface that simplifies integration into applications. Developers can access detailed installation and usage guides on Github.
Specify date values in controls with Unix timestamps
Date range controls and date controls now accept date values as Unix timestamps (milliseconds since epoch) when setting values with URL query string parameters or from an action.
Two-factor authentication email codes now expire after 5 minutes, instead of 15 minutes.
Inputting invalid SAML RelayState now displays error messages
When a SAML RelayState with invalid origin is entered, an error message is now displayed.
Workbook features
Layout grid is hidden by default
When editing workbooks and data models, grid lines are visible when moving elements and are otherwise hidden.
To show grid lines by default, you can modify the layout settings for a specific workbook. See Layout settings in Workbook settings overview.
Updated trigger type UI
In the Actions panel, action sequences are no longer added and grouped based on trigger type (On select, On change, On click, etc.). Each sequence indicates the trigger type, and you can select a different option from a dropdown when multiple types are available.
Bug fixes
When the embed team name contains an apostrophe, the embed sandbox no longer shows an "invalid embed signature" error and loads the embed successfully.
When you switch between Secure and JWT mode in the embed sandbox, Sigma now clears the URL field so that you can load the new embed without any error messages.
When hidden column values are passed to controls through workbook actions, those columns are now correctly excluded from Excel files.
Uniquely identify SAML attributes with the Sigma namespace prefix
You can now uniquely identify your SAML attributes by using the Sigma namespace prefix (https://schema.sigmacomputing.com/2025/01/claims). This can be applied to the userRole and userGroups attributes to avoid overlap with other app configurations. For example, the userRole attribute name would look like https://schema.sigmacomputing.com/2025/01/claims/userRole.
The List workbooks (GET /v2/workbooks) endpoint now supports two new optional query parameters:
The skipPermissionCheck parameter. When set to true, allows the API client to return all workbooks in a Sigma organization, including those not shared with the requesting user. The API client must have admin privileges to use this parameter.
The isArchived parameter. When set to true, filters the results to include only archived workbooks.
New userAttributes option for Create a connection and Update a connection endpoints
When adding a Snowflake connection with the Create a connection (POST /v2/connections) or updating one with the Update a connection (PUT /v2/connections/{connectionId}) endpoint, you can use the new userAttributes option to specify a user attribute to dynamically assign the role and the warehouse for the connection.
Sigma is now deployed in AWS US East (us-east-1). This region, located in Northern Virginia, is the largest AWS region and gives customers on the East Coast lower latency and enhanced performance when connecting to Sigma.
Workbook elements
Renaming visualization to chart
As part of ongoing improvements to UI terminology, references to "visualization" are now consistently updated to "chart".
Workbook features
EN-AU is now a supported locale
Sigma now supports Australian English localization, including date format and currency. You can preview a workbook or set custom translations with EN-AU.
Export data from a bookmark to a CSV, Excel, or JSON-formatted file.
Bug fixes
The Refresh element action now successfully refreshes data for elements on hidden pages.
The List columns for a workbook element endpoint (GET /v2/workbooks/{workbookId}/elements/{elementId}/columns) now correctly returns pagination data in the nextPage portion of the response.
Scheduled exports that email team members now send to the members of the team when the export is sent, instead of the members of the team when the schedule is added.
The SIGMA_SHARED schema in the Sigma Audit Logs connection now features a COMMENTS dimension table containing information about comment activity on workbooks and elements, including a full transcript, attachments, and mentioned users.
Restrict access to the Sigma API for your organization by adding IP addresses and IP address ranges using CIDR notation to an allowlist. With an allowlist configured, only users making API requests from allowed IP addresses can make successful requests.
When you write formulas in workbooks and data models, additional guidance is now available to help. If guidance is available, a wavy underline appears. Hover over the highlight to see a tip or a warning that your results might not be what you expect, and select Apply formula to update your formula with one click.
Workbook elements
Add custom data labels to area, bar, line, scatter, and combo charts
Select one or more columns to add custom data labels to area, bar, line, scatter, and combo charts.
Customize chart and formatting color scales (Beta)
You can now create custom color scales to use when formatting chart colors or conditional formatting for tables. Create a custom color scale for an organization theme, workbook theme, or for a specific data element.
Action trigger configurations for tables, pivot tables, and input tables
Tables, pivot tables, and input tables now support more ways to determine when and how user interaction triggers action sequences:
In the When selecting cells in column field, select Any column to trigger an action sequence when a user selects a cell in any column.
In the element’s Action panel, click More, then select or deselect Allow keyboard to trigger actions to control whether keyboard navigation within the element can trigger action sequences. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn’t display a checkmark, only pointer events can trigger them.
💡
Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.
Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.
Option to open workbook templates with actions
When configuring an Open Sigma doc action, you can now select a workbook template as the destination.
Bugfixes
You can now select specific tables in a data model when adding or changing data sources for an element.
Sigma no longer allows users to create input tables on an OAuth connection when an input table edit log destination is not configured.
The Add workbook schedule endpoint (POST /v2/workbooks/{workbookId}/schedules) now includes two new options:
The parameters option, allowing you to customize control values when programmatically adding an export schedule to a workbook.
The ownerId option, allowing you to specify a user to own the export schedule.
Workbook elements
Display images in pivot table cells
If your pivot table has a column that contains links to images, such as thumbnail images of retail products, you can transform the column to display the image links as images. You can set images to display in pivot table row, column, or values columns.
Easily show or hide totals for all levels of a grouped table. Right-click a table cell to open the context menu and select Show all totals or Hide all totals to show or hide totals for all grouping levels of the table.
When a value in a list control is selected, the display value is now shown instead of the raw value.
Formulas with an argument referencing a hidden control (control element on a hidden page) now evaluate successfully, regardless of the reference’s argument position.
When entering a table in a SQL query, the autocomplete dropdown now excludes tables that the user does not have permission to view.
Expanded options for actions that set control values
When configuring the Set control value action to update a List values control, the Set control selection to setting allows you to determine whether the action replaces or adds values to the existing control selection. This enhancement brings flexibility to the action in support of list controls that allow multiple value selections.
Custom digit grouping sizes supported
You can now set custom digit grouping sizes for numerical columns, to accommodate variances between number systems.
The Create a member (POST /v2/members) endpoint now returns an error if the email address is not in a valid format.
Improved data label positioning for bar charts. Bar charts that use a label style of Auto see fewer overlapping labels.
The appearance of KPI charts at smaller sizes is improved.
Showing or hiding totals on a grouped table now hides the totals row for the entire grouping level, instead of only removing the total value from the row.
When hiding totals in a pivot table, totals can now be hidden if the pivot values were placed above rows or columns.
Set up materialization to use dynamic tables (Beta)
If your Sigma organization has a Snowflake connection, you can configure materialization to use dynamic tables for materialization. New connections to Snowflake use dynamic tables for materialization by default.
Using dynamic tables enables incremental materialization, because dynamic tables use change tracking to determine which rows have changed, enabling Sigma to update only the rows that have changed instead of rebuilding the entire materialization. If there are no changes in the materialized table, the materialization is not run.
Two-factor authentication (2FA) was enabled by default for all new and existing users that use password-based authentication on December 11, 2024. Users with SAML or OAuth authentication methods (without password options enabled) were not affected.
Permission to restrict workbook data refresh settings
Restrict access to set an automatic refresh schedule for a workbook with a new permission, Set workbook data refresh. Enable the permission for account types associated with a Pro license. See License and account type overview.
Automatic refresh schedules rerun queries in an open workbook, such as when displaying a workbook on a screen viewed without interaction. See Manage workbook refresh options.
Restrict export frequency (Beta)
A new setting allows Sigma admins to restrict the frequency of scheduled exports for their organization. If this setting is enabled, users also cannot set custom cron schedules.
Inbound event for opening or closing export modals in an embed
Use the workbook:modal:toggle inbound event to open or close a modal in an embed. Currently supported modals are the Export modal and the Schedule exports modal.
To simplify design and build an app-like experience in a workbook, add one or more modals. When open, a modal overlays a workbook page, obscuring the background page and enabling a workbook viewer or explorer to focus on specific elements.
Use a modal for a number of use cases, including the following:
Reduce visual clutter by presenting controls and filters in a dedicated modal.
Provide instructions and other information in a modal.
Customize a chart or table drilldown by opening a modal with a filtered table with more details.
Use the SQL editor to build workbooks, datasets, and elements (tables, pivot tables, and visualizations) with custom SQL.
For more information about writing custom SQL in Sigma, see Write custom SQL.
Configure data labels per series on a bar chart (Beta)
If your bar chart or combo chart with bars visualizes multiple series of data, you can configure different data label settings for each series.
Workbook features
Interactive element highlighting
When you’re prompted to select an element from a dropdown list, Sigma highlights the applicable element within the workbook as you hover over element names in the list. This feature helps you locate, identify, and select the correct element.
Workbook action sequences (GA)
Configure an action sequence to run a set of workbook actions in a specific order.
Action sequences ensure user interactions trigger multiple actions in the order necessary to achieve a particular workbook response. Sigma allows you to add and reorder actions within a sequence, move actions between different sequences, and duplicate an existing sequence. You can also configure a condition that determines whether or not a sequence executes.
On OAuth authenticated connections, the Share Workbook modal now displays an expandable list of pending requests for access underneath the Sharing and OAuth information box, instead of an unscrollable list of users.
Sigma no longer returns a "No matching record" error when successfully activating or deactivating a user in the UI.
The GET /v2/templates endpoint now returns all templates the user has access to rather than only the templates they are the owner of.
Improved bar chart presentation for clustered bar charts.
