# Sigma Computing Documentation > Official documentation and help with data analysis and modeling, including guidance and best practices for building visualizations and dashboards for Sigma Computing, a cloud-based Business Intelligence (BI) platform. ## Guides - [Administer Sigma](https://help.sigmacomputing.com/docs/access-the-administration-portal.md) - [Create and manage workbook themes](https://help.sigmacomputing.com/docs/create-and-manage-workbook-themes.md) - [Customize email branding](https://help.sigmacomputing.com/docs/custom-email-branding.md) - [Upload custom fonts](https://help.sigmacomputing.com/docs/custom-fonts.md) - [Customize welcome and invite emails](https://help.sigmacomputing.com/docs/customize-welcome-and-invite-emails.md) - [Set up custom home pages](https://help.sigmacomputing.com/docs/enable-a-custom-homepage.md) - [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma.md) - [Configure mutual transport layer security (mTLS) for API connectors in Sigma](https://help.sigmacomputing.com/docs/configure-mutual-transport-layer-security-for-api-connectors-in-sigma.md) - [Tutorial: Configure API credentials, connectors, and actions for the NYC Open Data API](https://help.sigmacomputing.com/docs/tutorial-configure-api-credentials-connectors-and-actions-for-the-nyc-open-data-api.md) - [Tutorial: Configure API credentials, connectors, and actions for the Sigma REST API](https://help.sigmacomputing.com/docs/tutorial-configure-api-credentials-connectors-and-actions-for-the-sigma-rest-api.md) - [Access and explore audit logs](https://help.sigmacomputing.com/docs/access-and-explore-audit-logs.md) - [Audit log events and metadata](https://help.sigmacomputing.com/docs/audit-log-events-and-metadata.md) - [Enable or disable audit logging](https://help.sigmacomputing.com/docs/enable-audit-logging.md) - [Export audit log data to cloud storage](https://help.sigmacomputing.com/docs/export-audit-log-data-to-cloud-storage.md) - [Manage an audit logs storage integration](https://help.sigmacomputing.com/docs/manage-an-audit-logs-storage-integration.md) - [AI usage dashboard](https://help.sigmacomputing.com/docs/ai-usage.md) - [Assistant usage dashboard (Deprecated)](https://help.sigmacomputing.com/docs/assistant-usage.md) - [Usage overview](https://help.sigmacomputing.com/docs/usage-overview.md) - [Configure a Sigma OAuth application](https://help.sigmacomputing.com/docs/configure-a-sigma-oauth-application.md) - [Configure an OAuth application for Databricks](https://help.sigmacomputing.com/docs/configure-an-oauth-application-for-databricks.md) - [Configure OAuth authentication for your Sigma organization](https://help.sigmacomputing.com/docs/configure-oauth-authentication-for-your-sigma-organization.md) - [About using OAuth with Sigma](https://help.sigmacomputing.com/docs/configure-oauth.md) - [Custom Session Timeouts for Okta](https://help.sigmacomputing.com/docs/custom-session-timeouts-for-okta.md) - [About using customer-managed keys in Sigma](https://help.sigmacomputing.com/docs/customer-managed-keys-cmk-faqs.md) - [Set up customer-managed keys](https://help.sigmacomputing.com/docs/set-up-customer-managed-keys-cmk.md) - [Manage password authentication](https://help.sigmacomputing.com/docs/manage-password-authentication.md) - [Manage users and teams with SCIM and Okta](https://help.sigmacomputing.com/docs/manage-users-and-teams-with-scim-and-okta.md) - [Manage users and teams with SCIM](https://help.sigmacomputing.com/docs/manage-users-and-teams-with-scim.md) - [Authentication methods for your Sigma organization](https://help.sigmacomputing.com/docs/organization-authentication-methods.md) - [Restrict access to Sigma by IP address](https://help.sigmacomputing.com/docs/restrict-access-to-sigma-by-ip-address.md) - [Set up inactivity timeouts](https://help.sigmacomputing.com/docs/set-up-inactivity-timeouts.md) - [Set up single sign-on with SAML](https://help.sigmacomputing.com/docs/single-sign-on-with-saml.md) - [Use custom account types with your IdP](https://help.sigmacomputing.com/docs/use-custom-account-types-with-your-idp.md) - [Using multiple identity providers for your Sigma organization](https://help.sigmacomputing.com/docs/using-multiple-identity-providers-for-your-sigma-organization.md) - [Register a Plugin with your Sigma Organization](https://help.sigmacomputing.com/docs/register-a-plugin-with-your-sigma-organization.md) - [Register a Sigma Plugin Dev Playground](https://help.sigmacomputing.com/docs/register-a-sigma-plugin-dev-playground.md) - [Change the account time zone](https://help.sigmacomputing.com/docs/account-time-zone.md) - [Manage organization locale](https://help.sigmacomputing.com/docs/manage-organization-locale.md) - [Manage organization translation files](https://help.sigmacomputing.com/docs/manage-organization-translation-files.md) - [Create and manage version tags](https://help.sigmacomputing.com/docs/create-and-manage-version-tags.md) - [Manage materializations](https://help.sigmacomputing.com/docs/manage-materializations.md) - [Manage organization schedules](https://help.sigmacomputing.com/docs/manage-organization-schedules.md) - [Recover deleted documents](https://help.sigmacomputing.com/docs/recover-deleted-documents.md) - [Review warehouse view details](https://help.sigmacomputing.com/docs/review-warehouse-view-details.md) - [View your organization's automated action sequences (Beta)](https://help.sigmacomputing.com/docs/view-automated-action-sequences.md) - [Configure an external storage integration with Amazon S3](https://help.sigmacomputing.com/docs/configure-an-external-storage-integration-with-amazon-s3.md) - [Configure an external storage integration with Azure Blob Storage](https://help.sigmacomputing.com/docs/configure-an-external-storage-integration-with-azure-blob.md) - [Configure an external storage integration with Google Cloud Storage](https://help.sigmacomputing.com/docs/configure-an-external-storage-integration-with-gcs.md) - [External storage integration overview](https://help.sigmacomputing.com/docs/external-storage-integration-overview.md) - [Configure the AI usage dashboard](https://help.sigmacomputing.com/docs/configure-a-usage-dashboard-for-assistant.md) - [Configure token usage limits for AI columns (Beta)](https://help.sigmacomputing.com/docs/configure-ai-column-token-limit.md) - [Add MCP tools to Sigma (Beta)](https://help.sigmacomputing.com/docs/configure-mcp-tools.md) - [Configure a warehouse-hosted model as AI provider](https://help.sigmacomputing.com/docs/configure-warehouse-ai-model-integration.md) - [Configure AI features for your organization](https://help.sigmacomputing.com/docs/configure-ai-features-for-your-organization.md) - [Configure an external AI provider](https://help.sigmacomputing.com/docs/manage-external-ai-integrations.md) - [Notice for enabling AI-enabled features in Sigma](https://help.sigmacomputing.com/docs/notice-for-enabling-ai-enabled-features-in-sigma.md) - [Use warehouse agents with Sigma (Beta)](https://help.sigmacomputing.com/docs/use-warehouse-agents-sigma.md) - [Configure CSV upload and storage options](https://help.sigmacomputing.com/docs/configure-csv-upload-and-storage-options.md) - [Enable or disable comments](https://help.sigmacomputing.com/docs/disable-commenting.md) - [Enable or disable public embeds](https://help.sigmacomputing.com/docs/enable-or-disable-public-embeds.md) - [Enable or disable account upgrade requests](https://help.sigmacomputing.com/docs/license-upgrade-requests.md) - [Manage annotated image ability and storage period](https://help.sigmacomputing.com/docs/manage-annotated-images-in-comments.md) - [Manage export frequency and authentication settings](https://help.sigmacomputing.com/docs/restrict-export-recipients.md) - [Deactivate users](https://help.sigmacomputing.com/docs/deactivate-users.md) - [Guest User Accounts](https://help.sigmacomputing.com/docs/guest-user-accounts.md) - [Impersonate users](https://help.sigmacomputing.com/docs/impersonate-users.md) - [Invite new users to your organization](https://help.sigmacomputing.com/docs/invite-new-organization-members.md) - [Manage Users with User 360](https://help.sigmacomputing.com/docs/manage-users-with-user-360.md) - [Manage team admins](https://help.sigmacomputing.com/docs/manage-team-admins.md) - [Manage team members](https://help.sigmacomputing.com/docs/manage-team-members.md) - [Create and manage teams](https://help.sigmacomputing.com/docs/manage-teams.md) - [Manage workspaces](https://help.sigmacomputing.com/docs/manage-workspaces.md) - [Account type and license overview](https://help.sigmacomputing.com/docs/account-type-and-license-overview.md) - [Basic explore vs. Full explore](https://help.sigmacomputing.com/docs/basic-explore-vs-full-explore.md) - [Create and manage account types](https://help.sigmacomputing.com/docs/create-and-manage-account-types.md) - [Respond to account upgrade requests](https://help.sigmacomputing.com/docs/respond-to-account-upgrade-requests.md) - [View license utilization](https://help.sigmacomputing.com/docs/view-license-utilization.md) - [Data access overview](https://help.sigmacomputing.com/docs/data-permissions-overview.md) - [Manage access to data and connections](https://help.sigmacomputing.com/docs/manage-data-permissions.md) - [Folder and document access](https://help.sigmacomputing.com/docs/folder-and-document-permissions.md) - [Configure user attributes](https://help.sigmacomputing.com/docs/user-attributes.md) - [Configure a dbt Semantic Layer integration](https://help.sigmacomputing.com/docs/configure-a-dbt-semantic-layer-integration.md) - [Manage dbt integration](https://help.sigmacomputing.com/docs/manage-dbt-integration.md) - [Manage Microsoft integration](https://help.sigmacomputing.com/docs/manage-microsoft-integration.md) - [Manage Slack integration](https://help.sigmacomputing.com/docs/manage-slack-integration.md) - [Ad hoc data explorations](https://help.sigmacomputing.com/docs/ad-hoc-data-explorations.md) - [Copy and paste workbook elements](https://help.sigmacomputing.com/docs/copy-and-paste-elements.md) - [Copy workbook pages](https://help.sigmacomputing.com/docs/copy-and-paste-workbook-pages.md) - [Create a workbook](https://help.sigmacomputing.com/docs/create-a-workbook.md) - [Create AI columns (Beta)](https://help.sigmacomputing.com/docs/create-ai-columns.md) - [Design workbook layouts](https://help.sigmacomputing.com/docs/design-workbook-layouts.md) - [Draft and publish a workbook](https://help.sigmacomputing.com/docs/edit-draft-and-publish-a-workbook.md) - [Use Sigma Assistant to build dashboards and apps (Beta)](https://help.sigmacomputing.com/docs/use-ai-to-build-dashboards-and-apps.md) - [Use your organization's plugins](https://help.sigmacomputing.com/docs/use-your-organizations-plugins.md) - [Add columns through Lookup](https://help.sigmacomputing.com/docs/add-columns-through-lookup.md) - [Create a data element](https://help.sigmacomputing.com/docs/create-a-data-element.md) - [Create and edit period-over-period analysis](https://help.sigmacomputing.com/docs/create-and-edit-period-over-period-analysis.md) - [Organize columns into folders](https://help.sigmacomputing.com/docs/organize-columns-into-folders.md) - [Use linked columns in workbooks](https://help.sigmacomputing.com/docs/use-linked-columns-in-workbooks.md) - [Use related columns in a workbook or data model](https://help.sigmacomputing.com/docs/use-related-columns-in-a-workbook.md) - [Query a dbt Semantic Layer integration](https://help.sigmacomputing.com/docs/query-a-dbt-semantic-layer-integration.md) - [Query and extend Snowflake semantic views in Sigma (Beta)](https://help.sigmacomputing.com/docs/query-and-extend-snowflake-semantic-views-in-sigma.md) - [Reference workbook control values in SQL statements](https://help.sigmacomputing.com/docs/reference-workbook-control-values-in-sql-statements.md) - [Write custom SQL](https://help.sigmacomputing.com/docs/write-custom-sql.md) - [Build Sigma agents (Beta)](https://help.sigmacomputing.com/docs/build-agents.md) - [Chat with Sigma agents (Beta)](https://help.sigmacomputing.com/docs/chat-with-agent.md) - [Example use cases for Sigma agents (Beta)](https://help.sigmacomputing.com/docs/example-agent-implementations.md) - [About Sigma agents (Beta)](https://help.sigmacomputing.com/docs/sigma-agents.md) - [Add hyperlinks and images to columns](https://help.sigmacomputing.com/docs/add-hyperlinks-to-columns.md) - [Create a table from an array (Beta)](https://help.sigmacomputing.com/docs/create-a-table-from-an-array.md) - [Create and manage tables](https://help.sigmacomputing.com/docs/create-and-manage-tables.md) - [Extract columns from JSON or variant data](https://help.sigmacomputing.com/docs/extract-columns-from-json-or-variant-data.md) - [Format and customize a table](https://help.sigmacomputing.com/docs/format-and-customize-a-table.md) - [Create ad hoc calculations](https://help.sigmacomputing.com/docs/create-ad-hoc-calculations.md) - [Format pivot table totals](https://help.sigmacomputing.com/docs/format-pivot-table-totals.md) - [Work with hierarchies](https://help.sigmacomputing.com/docs/hierarchies.md) - [Pivot table totals and subtotals](https://help.sigmacomputing.com/docs/pivot-table-subtotals.md) - [Working with pivot tables](https://help.sigmacomputing.com/docs/working-with-pivot-tables.md) - [Transpose a table](https://help.sigmacomputing.com/docs/transpose-a-table.md) - [Collaborate with Live Edit in workbooks](https://help.sigmacomputing.com/docs/collaborate-with-live-edit-in-workbooks.md) - [Intro to Element Types](https://help.sigmacomputing.com/docs/intro-to-element-types.md) - [Navigate a workbook](https://help.sigmacomputing.com/docs/navigating-a-workbook.md) - [Workbook modes overview](https://help.sigmacomputing.com/docs/workbook-modes-overview.md) - [Workbooks overview](https://help.sigmacomputing.com/docs/workbooks-overview.md) - [Python method reference](https://help.sigmacomputing.com/docs/python-method-reference.md) - [Write and run Python code in Sigma](https://help.sigmacomputing.com/docs/write-and-run-python-code.md) - [Build if/else control flow in an action sequence](https://help.sigmacomputing.com/docs/build-if-else-control-flow-in-an-action-sequence.md) - [Run action sequences automatically (Beta)](https://help.sigmacomputing.com/docs/configure-action-sequences-to-run-automatically.md) - [Create and manage action sequences](https://help.sigmacomputing.com/docs/create-and-manage-action-sequences.md) - [Create cross-element filters](https://help.sigmacomputing.com/docs/create-cross-element-filters.md) - [Create custom context menu actions](https://help.sigmacomputing.com/docs/create-custom-context-menu-actions.md) - [Define an action condition](https://help.sigmacomputing.com/docs/make-an-action-conditional.md) - [Use variables in actions](https://help.sigmacomputing.com/docs/use-variables-in-actions.md) - [View and manage existing actions](https://help.sigmacomputing.com/docs/view-and-manage-existing-actions.md) - [Intro to actions](https://help.sigmacomputing.com/docs/intro-to-actions.md) - [Create actions that call API endpoints](https://help.sigmacomputing.com/docs/create-actions-that-call-api-endpoints.md) - [Create actions that call stored procedures](https://help.sigmacomputing.com/docs/create-actions-that-call-stored-procedures.md) - [Create actions that control modals and tabbed containers](https://help.sigmacomputing.com/docs/create-actions-that-control-modals-and-tabbed-containers.md) - [Create actions that control single row containers](https://help.sigmacomputing.com/docs/create-actions-that-control-single-row-containers.md) - [Create actions to interact with Sigma agents (Beta)](https://help.sigmacomputing.com/docs/create-actions-that-interact-with-agents.md) - [Create actions that manage control values](https://help.sigmacomputing.com/docs/create-actions-that-manage-control-values.md) - [Create actions that modify forms](https://help.sigmacomputing.com/docs/create-actions-that-modify-forms.md) - [Create actions that modify input table data](https://help.sigmacomputing.com/docs/create-actions-that-modify-input-table-data.md) - [Create actions that modify or refresh elements](https://help.sigmacomputing.com/docs/create-actions-that-modify-or-refresh-elements.md) - [Create actions that modify plugins](https://help.sigmacomputing.com/docs/create-actions-that-modify-plugins.md) - [Create actions that navigate to destinations](https://help.sigmacomputing.com/docs/create-actions-that-navigate-to-destinations.md) - [Create actions that send notifications and export data](https://help.sigmacomputing.com/docs/create-actions-that-send-notifications-and-export-data.md) - [Create actions that generate embed iframe events](https://help.sigmacomputing.com/docs/create-actions-that-trigger-embed-iframe-events.md) - [Edit input table data](https://help.sigmacomputing.com/docs/add-or-edit-input-table-data.md) - [Add system-generated columns to input tables](https://help.sigmacomputing.com/docs/add-system-generated-columns-to-input-tables.md) - [Apply data validation to input table columns](https://help.sigmacomputing.com/docs/apply-data-validation-to-input-table-columns.md) - [Configure file columns in input tables (Beta)](https://help.sigmacomputing.com/docs/configure-file-upload-columns-on-input-tables.md) - [Configure single-select or multi-select columns in input tables](https://help.sigmacomputing.com/docs/configure-single-select-and-multi-select-columns-on-input-tables.md) - [Create new input tables](https://help.sigmacomputing.com/docs/create-new-input-tables.md) - [Change the data entry permission on input tables](https://help.sigmacomputing.com/docs/customize-data-entry-permission-on-input-tables.md) - [Input tables overview](https://help.sigmacomputing.com/docs/intro-to-input-tables.md) - [View input table audit history](https://help.sigmacomputing.com/docs/view-input-table-audit-history.md) - [App tutorial: Build an employee feedback survey](https://help.sigmacomputing.com/docs/app-tutorial-data-collection.md) - [About Sigma AI apps](https://help.sigmacomputing.com/docs/ai-apps.md) - [Intro to layout elements](https://help.sigmacomputing.com/docs/intro-to-layout-elements.md) - [Use containers to organize workbook layouts](https://help.sigmacomputing.com/docs/use-containers-to-organize-workbook-layouts.md) - [Use forms to streamline user data entry](https://help.sigmacomputing.com/docs/use-forms-to-streamline-user-data-entry.md) - [Use modals to create focused content views](https://help.sigmacomputing.com/docs/use-modals-to-create-focused-content-views.md) - [Use popovers to simplify a workbook interface](https://help.sigmacomputing.com/docs/use-popovers-to-simplify-a-workbook-interface.md) - [Use repeated containers to generate layouts from data](https://help.sigmacomputing.com/docs/use-repeated-containers-to-generate-layouts-from-data.md) - [Use single row containers to show records in detail](https://help.sigmacomputing.com/docs/use-single-row-containers-to-show-records-in-detail.md) - [Use tabbed containers to organize workbook content](https://help.sigmacomputing.com/docs/use-tabbed-containers-to-organize-workbook-content.md) - [Use the navigation element to guide user exploration](https://help.sigmacomputing.com/docs/use-the-navigation-element-to-guide-user-exploration.md) - [Example representation: Data model with a checkbox control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-checkbox-control.md) - [Example representation: Data model with a custom SQL element](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-custom-sql-element.md) - [Example representation: Data model with a date control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-date-control.md) - [Example representation: Data model with a date range control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-date-range-control.md) - [Example representation: Data model with a folder](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-folder.md) - [Example representation: Data model with a grouping](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-grouping.md) - [Example representation: Data model with a join](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-join.md) - [Example representation: Data model with a list values control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-list-values-control.md) - [Example representation: Data model with a metric timeline](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-metric-timeline.md) - [Example representation: Data model with a number input control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-number-input-control.md) - [Example representation: Data model with a number range control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-number-range-control.md) - [Example representation: Data model with a range slider control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-range-slider-control.md) - [Example representation: Data model with a segmented control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-segmented-control.md) - [Example representation: Data model with a single table](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-single-table.md) - [Example representation: Data model with a slider control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-slider-control.md) - [Example representation: Data model with a switch control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-switch-control.md) - [Example representation: Data model with a table and a calculated column](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-table-and-a-calculated-column.md) - [Example representation: Data model with a table and metric](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-table-and-a-metric.md) - [Example representation: Data model with a table and relationship](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-table-and-a-relationship.md) - [Example representation: Data model with a text area control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-text-area-control.md) - [Example representation: Data model with a text input control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-text-input-control.md) - [Example representation: Data model with a top N control](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-top-n-control.md) - [Example representation: Data model with a transposed table](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-transposed-table.md) - [Example representation: Data model with a union](https://help.sigmacomputing.com/docs/example-representation-data-model-with-a-union.md) - [Example representation: Data model with column-level security](https://help.sigmacomputing.com/docs/example-representation-data-model-with-column-level-security.md) - [Example representation: Data model with filters](https://help.sigmacomputing.com/docs/example-representation-data-model-with-filters.md) - [Data model representation example library](https://help.sigmacomputing.com/docs/data-model-representation-example-library.md) - [Create a data model from a code representation](https://help.sigmacomputing.com/docs/create-a-data-model-from-a-code-representation.md) - [Format columns and metrics in the code representation of a data model](https://help.sigmacomputing.com/docs/format-columns-and-metrics-in-the-code-representation-of-a-data-model.md) - [Get the code representation of a data model](https://help.sigmacomputing.com/docs/get-the-code-representation-of-a-data-model.md) - [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code.md) - [Sort data in the code representation of a data model](https://help.sigmacomputing.com/docs/sort-data-in-the-code-representation-of-a-data-model.md) - [Specify column order in the code representation of a data model](https://help.sigmacomputing.com/docs/specify-column-order-in-the-code-representation-of-a-data-model.md) - [Update a data model from a code representation](https://help.sigmacomputing.com/docs/update-a-data-model-from-a-code-representation.md) - [Sigma CLI](https://help.sigmacomputing.com/docs/sigma-cli.md) - [Install and configure the Sigma CLI](https://help.sigmacomputing.com/docs/install-and-configure-the-sigma-cli.md) - [Use the Sigma CLI](https://help.sigmacomputing.com/docs/use-the-sigma-cli.md) - [Add elements and data to a report](https://help.sigmacomputing.com/docs/add-elements-and-data-to-a-report.md) - [Create and edit reports](https://help.sigmacomputing.com/docs/create-and-edit-reports.md) - [Customize element size, layering, and alignment in reports](https://help.sigmacomputing.com/docs/customize-element-size-position-and-layering.md) - [Customize report settings and themes](https://help.sigmacomputing.com/docs/customize-report-elements-settings-and-branding.md) - [Customize text typeface, size, and style in reports](https://help.sigmacomputing.com/docs/customize-text-typeface-size-and-style.md) - [Edit report page order, visibility, and numbers](https://help.sigmacomputing.com/docs/edit-report-page-order-visibility-and-numbers.md) - [Edit report page setup, headers, and footers](https://help.sigmacomputing.com/docs/edit-report-page-setup-headers-and-footers.md) - [Reports overview](https://help.sigmacomputing.com/docs/reports-overview.md) - [Share and export reports](https://help.sigmacomputing.com/docs/share-and-export-reports.md) - [Tutorial: Build and export a sales report](https://help.sigmacomputing.com/docs/tutorial-build-and-export-a-sales-report.md) - [Create reusable custom functions](https://help.sigmacomputing.com/docs/custom-functions.md) - [ArrayAgg](https://help.sigmacomputing.com/docs/arrayagg.md) - [ArrayAggDistinct](https://help.sigmacomputing.com/docs/arrayaggdistinct.md) - [Avg](https://help.sigmacomputing.com/docs/avg.md) - [AvgIf](https://help.sigmacomputing.com/docs/avgif.md) - [Corr](https://help.sigmacomputing.com/docs/corr.md) - [Count](https://help.sigmacomputing.com/docs/count.md) - [CountDistinct](https://help.sigmacomputing.com/docs/countdistinct.md) - [CountDistinctIf](https://help.sigmacomputing.com/docs/countdistinctif.md) - [CountIf](https://help.sigmacomputing.com/docs/countif.md) - [GrandTotal](https://help.sigmacomputing.com/docs/grandtotal.md) - [Aggregate functions](https://help.sigmacomputing.com/docs/aggregate-functions.md) - [ListAgg](https://help.sigmacomputing.com/docs/listagg.md) - [ListAggDistinct](https://help.sigmacomputing.com/docs/listaggdistinct.md) - [Max](https://help.sigmacomputing.com/docs/max.md) - [MaxIf](https://help.sigmacomputing.com/docs/maxif.md) - [Median](https://help.sigmacomputing.com/docs/median.md) - [Min](https://help.sigmacomputing.com/docs/min.md) - [MinIf](https://help.sigmacomputing.com/docs/minif.md) - [PercentileCont](https://help.sigmacomputing.com/docs/percentilecont.md) - [PercentileDisc](https://help.sigmacomputing.com/docs/percentiledisc.md) - [PercentOfTotal](https://help.sigmacomputing.com/docs/percentoftotal.md) - [RegressionIntercept](https://help.sigmacomputing.com/docs/regressionintercept.md) - [RegressionR2](https://help.sigmacomputing.com/docs/regressionr2.md) - [RegressionSlope](https://help.sigmacomputing.com/docs/regressionslope.md) - [StdDev](https://help.sigmacomputing.com/docs/stddev.md) - [Subtotal](https://help.sigmacomputing.com/docs/subtotal.md) - [Sum](https://help.sigmacomputing.com/docs/sum.md) - [SumIf](https://help.sigmacomputing.com/docs/sumif.md) - [SumProduct](https://help.sigmacomputing.com/docs/sumproduct.md) - [Variance](https://help.sigmacomputing.com/docs/variance.md) - [VariancePop](https://help.sigmacomputing.com/docs/variancepop.md) - [Array](https://help.sigmacomputing.com/docs/array.md) - [ArrayCompact](https://help.sigmacomputing.com/docs/arraycompact.md) - [ArrayConcat](https://help.sigmacomputing.com/docs/arrayconcat.md) - [ArrayContains](https://help.sigmacomputing.com/docs/arraycontains.md) - [ArrayDistinct](https://help.sigmacomputing.com/docs/arraydistinct.md) - [ArrayExcept](https://help.sigmacomputing.com/docs/arrayexcept.md) - [ArrayIntersection](https://help.sigmacomputing.com/docs/arrayintersection.md) - [ArrayJoin](https://help.sigmacomputing.com/docs/arrayjoin.md) - [ArrayLength](https://help.sigmacomputing.com/docs/arraylength.md) - [ArraySlice](https://help.sigmacomputing.com/docs/arrayslice.md) - [Array functions](https://help.sigmacomputing.com/docs/array-functions.md) - [RaggedHierarchy](https://help.sigmacomputing.com/docs/raggedhierarchy.md) - [Sequence](https://help.sigmacomputing.com/docs/sequence.md) - [Sparkline](https://help.sigmacomputing.com/docs/sparkline.md) - [SparklineAgg](https://help.sigmacomputing.com/docs/sparklineagg.md) - [SplitToArray](https://help.sigmacomputing.com/docs/splittoarray.md) - [ConvertTimezone](https://help.sigmacomputing.com/docs/converttimezone.md) - [DateAdd](https://help.sigmacomputing.com/docs/dateadd.md) - [DateDiff](https://help.sigmacomputing.com/docs/datediff.md) - [DateFormat](https://help.sigmacomputing.com/docs/dateformat.md) - [DateFromUnix](https://help.sigmacomputing.com/docs/datefromunix.md) - [DateFromUnixMs](https://help.sigmacomputing.com/docs/datefromunixms.md) - [DateFromUnixUs](https://help.sigmacomputing.com/docs/datefromunixus.md) - [DateLookback](https://help.sigmacomputing.com/docs/datelookback.md) - [DateParse](https://help.sigmacomputing.com/docs/dateparse.md) - [DatePart](https://help.sigmacomputing.com/docs/datepart.md) - [DateTrunc](https://help.sigmacomputing.com/docs/datetrunc.md) - [Day](https://help.sigmacomputing.com/docs/day.md) - [DayOfYear](https://help.sigmacomputing.com/docs/dayofyear.md) - [EndOfMonth](https://help.sigmacomputing.com/docs/endofmonth.md) - [Hour](https://help.sigmacomputing.com/docs/hour.md) - [InDateRange](https://help.sigmacomputing.com/docs/indaterange.md) - [Date functions](https://help.sigmacomputing.com/docs/date-functions.md) - [InPriorDateRange](https://help.sigmacomputing.com/docs/inpriordaterange.md) - [LastDay](https://help.sigmacomputing.com/docs/lastday.md) - [MakeDate](https://help.sigmacomputing.com/docs/makedate.md) - [Minute](https://help.sigmacomputing.com/docs/minute.md) - [Month](https://help.sigmacomputing.com/docs/month.md) - [MonthName](https://help.sigmacomputing.com/docs/monthname.md) - [Now](https://help.sigmacomputing.com/docs/now.md) - [Quarter](https://help.sigmacomputing.com/docs/quarter.md) - [Second](https://help.sigmacomputing.com/docs/second.md) - [Today](https://help.sigmacomputing.com/docs/today.md) - [Weekday](https://help.sigmacomputing.com/docs/weekday.md) - [WeekdayName](https://help.sigmacomputing.com/docs/weekdayname.md) - [Year](https://help.sigmacomputing.com/docs/year.md) - [CAGR](https://help.sigmacomputing.com/docs/cagr.md) - [Effect](https://help.sigmacomputing.com/docs/effect.md) - [FV](https://help.sigmacomputing.com/docs/fv.md) - [Financial functions](https://help.sigmacomputing.com/docs/financial-functions.md) - [IPmt](https://help.sigmacomputing.com/docs/ipmt.md) - [Nominal](https://help.sigmacomputing.com/docs/nominal.md) - [NPer](https://help.sigmacomputing.com/docs/nper.md) - [Pmt](https://help.sigmacomputing.com/docs/pmt.md) - [PPmt](https://help.sigmacomputing.com/docs/ppmt.md) - [PV](https://help.sigmacomputing.com/docs/pv.md) - [XNPV](https://help.sigmacomputing.com/docs/xnpv.md) - [Function index](https://help.sigmacomputing.com/docs/function-index.md) - [Area](https://help.sigmacomputing.com/docs/area.md) - [Centroid](https://help.sigmacomputing.com/docs/centroid.md) - [Distance](https://help.sigmacomputing.com/docs/distance.md) - [Geography](https://help.sigmacomputing.com/docs/geography.md) - [Geography functions](https://help.sigmacomputing.com/docs/geography-functions.md) - [Intersects](https://help.sigmacomputing.com/docs/intersects.md) - [Latitude](https://help.sigmacomputing.com/docs/latitude.md) - [Longitude](https://help.sigmacomputing.com/docs/longitude.md) - [MakeLine](https://help.sigmacomputing.com/docs/makeline.md) - [MakePoint](https://help.sigmacomputing.com/docs/makepoint.md) - [Perimeter](https://help.sigmacomputing.com/docs/perimeter.md) - [Within](https://help.sigmacomputing.com/docs/within.md) - [Join functions](https://help.sigmacomputing.com/docs/join-functions.md) - [Lookup](https://help.sigmacomputing.com/docs/lookup.md) - [Rollup](https://help.sigmacomputing.com/docs/rollup.md) - [Between](https://help.sigmacomputing.com/docs/between.md) - [Choose](https://help.sigmacomputing.com/docs/choose.md) - [Coalesce](https://help.sigmacomputing.com/docs/coalesce.md) - [If](https://help.sigmacomputing.com/docs/if.md) - [In](https://help.sigmacomputing.com/docs/in.md) - [Logical functions](https://help.sigmacomputing.com/docs/logical-functions.md) - [IsNotNull](https://help.sigmacomputing.com/docs/isnotnull.md) - [IsNull](https://help.sigmacomputing.com/docs/isnull.md) - [NullIf](https://help.sigmacomputing.com/docs/nullif.md) - [Switch](https://help.sigmacomputing.com/docs/switch.md) - [Zn](https://help.sigmacomputing.com/docs/zn.md) - [Abs](https://help.sigmacomputing.com/docs/abs.md) - [Acos](https://help.sigmacomputing.com/docs/acos.md) - [Asin](https://help.sigmacomputing.com/docs/asin.md) - [Atan](https://help.sigmacomputing.com/docs/atan.md) - [Atan2](https://help.sigmacomputing.com/docs/atan2.md) - [BinFixed](https://help.sigmacomputing.com/docs/binfixed.md) - [BinRange](https://help.sigmacomputing.com/docs/binrange.md) - [BitAnd](https://help.sigmacomputing.com/docs/bitand.md) - [BitOr](https://help.sigmacomputing.com/docs/bitor.md) - [Ceiling](https://help.sigmacomputing.com/docs/ceiling.md) - [Cos](https://help.sigmacomputing.com/docs/cos.md) - [Cot](https://help.sigmacomputing.com/docs/cot.md) - [Degrees](https://help.sigmacomputing.com/docs/degrees.md) - [DistanceGlobe](https://help.sigmacomputing.com/docs/distanceglobe.md) - [DistancePlane](https://help.sigmacomputing.com/docs/distanceplane.md) - [Div](https://help.sigmacomputing.com/docs/div.md) - [Exp](https://help.sigmacomputing.com/docs/exp.md) - [Floor](https://help.sigmacomputing.com/docs/floor.md) - [Greatest](https://help.sigmacomputing.com/docs/greatest.md) - [GreatestNonNull](https://help.sigmacomputing.com/docs/greatestnonnull.md) - [Math functions](https://help.sigmacomputing.com/docs/math-functions.md) - [Int](https://help.sigmacomputing.com/docs/int.md) - [IsEven](https://help.sigmacomputing.com/docs/iseven.md) - [IsOdd](https://help.sigmacomputing.com/docs/isodd.md) - [Least](https://help.sigmacomputing.com/docs/least.md) - [LeastNonNull](https://help.sigmacomputing.com/docs/leastnonnull.md) - [Ln](https://help.sigmacomputing.com/docs/ln.md) - [Log](https://help.sigmacomputing.com/docs/log.md) - [Mod](https://help.sigmacomputing.com/docs/mod.md) - [MRound](https://help.sigmacomputing.com/docs/mround.md) - [Pi](https://help.sigmacomputing.com/docs/pi.md) - [Power](https://help.sigmacomputing.com/docs/power.md) - [Radians](https://help.sigmacomputing.com/docs/radians.md) - [Round](https://help.sigmacomputing.com/docs/round.md) - [RoundDown](https://help.sigmacomputing.com/docs/rounddown.md) - [RoundUp](https://help.sigmacomputing.com/docs/roundup.md) - [RowAvg](https://help.sigmacomputing.com/docs/rowavg.md) - [Sign](https://help.sigmacomputing.com/docs/sign.md) - [Sin](https://help.sigmacomputing.com/docs/sin.md) - [Sqrt](https://help.sigmacomputing.com/docs/sqrt.md) - [Tan](https://help.sigmacomputing.com/docs/tan.md) - [Trunc](https://help.sigmacomputing.com/docs/trunc.md) - [AggDatetime](https://help.sigmacomputing.com/docs/aggdatetime.md) - [AggGeography](https://help.sigmacomputing.com/docs/agggeography.md) - [AggLogical](https://help.sigmacomputing.com/docs/agglogical.md) - [AggNumber](https://help.sigmacomputing.com/docs/aggnumber.md) - [AggText](https://help.sigmacomputing.com/docs/aggtext.md) - [AggVariant](https://help.sigmacomputing.com/docs/aggvariant.md) - [CallDatetime](https://help.sigmacomputing.com/docs/calldatetime.md) - [CallGeography](https://help.sigmacomputing.com/docs/callgeography.md) - [CallLogical](https://help.sigmacomputing.com/docs/calllogical.md) - [CallNumber](https://help.sigmacomputing.com/docs/callnumber.md) - [CallText](https://help.sigmacomputing.com/docs/calltext.md) - [CallVariant](https://help.sigmacomputing.com/docs/callvariant.md) - [Passthrough functions](https://help.sigmacomputing.com/docs/passthrough-functions.md) - [CurrentTimezone](https://help.sigmacomputing.com/docs/currenttimezone.md) - [CurrentUserAttributeText](https://help.sigmacomputing.com/docs/currentuserattributetext.md) - [CurrentUserEmail](https://help.sigmacomputing.com/docs/currentuseremail.md) - [CurrentUserFirstName](https://help.sigmacomputing.com/docs/currentuserfirstname.md) - [CurrentUserFullName](https://help.sigmacomputing.com/docs/currentuserfullname.md) - [CurrentUserInTeam](https://help.sigmacomputing.com/docs/currentuserinteam.md) - [System functions](https://help.sigmacomputing.com/docs/system-functions.md) - [Concat](https://help.sigmacomputing.com/docs/concat.md) - [Contains](https://help.sigmacomputing.com/docs/contains.md) - [EndsWith](https://help.sigmacomputing.com/docs/endswith.md) - [Find](https://help.sigmacomputing.com/docs/find.md) - [ILike](https://help.sigmacomputing.com/docs/ilike.md) - [Text functions](https://help.sigmacomputing.com/docs/text-functions.md) - [Left](https://help.sigmacomputing.com/docs/left.md) - [Len](https://help.sigmacomputing.com/docs/len.md) - [Like](https://help.sigmacomputing.com/docs/like.md) - [Lower](https://help.sigmacomputing.com/docs/lower.md) - [LPad](https://help.sigmacomputing.com/docs/lpad.md) - [LTrim](https://help.sigmacomputing.com/docs/ltrim.md) - [MD5](https://help.sigmacomputing.com/docs/md5.md) - [Mid](https://help.sigmacomputing.com/docs/mid.md) - [Proper](https://help.sigmacomputing.com/docs/proper.md) - [RegexpCount](https://help.sigmacomputing.com/docs/regexpcount.md) - [RegexpExtract](https://help.sigmacomputing.com/docs/regexpextract.md) - [RegexpMatch](https://help.sigmacomputing.com/docs/regexpmatch.md) - [RegexpReplace](https://help.sigmacomputing.com/docs/regexpreplace.md) - [Repeat](https://help.sigmacomputing.com/docs/repeat.md) - [Replace](https://help.sigmacomputing.com/docs/replace.md) - [Reverse](https://help.sigmacomputing.com/docs/reverse.md) - [Right](https://help.sigmacomputing.com/docs/right.md) - [RPad](https://help.sigmacomputing.com/docs/rpad.md) - [RTrim](https://help.sigmacomputing.com/docs/rtrim.md) - [SHA256](https://help.sigmacomputing.com/docs/sha256.md) - [SplitPart](https://help.sigmacomputing.com/docs/splitpart.md) - [StartsWith](https://help.sigmacomputing.com/docs/startswith.md) - [Substring](https://help.sigmacomputing.com/docs/substring.md) - [Trim](https://help.sigmacomputing.com/docs/trim.md) - [Upper](https://help.sigmacomputing.com/docs/upper.md) - [UrlPart](https://help.sigmacomputing.com/docs/urlpart.md) - [Date](https://help.sigmacomputing.com/docs/date.md) - [Type functions](https://help.sigmacomputing.com/docs/type-functions.md) - [Json](https://help.sigmacomputing.com/docs/json.md) - [Logical](https://help.sigmacomputing.com/docs/logical.md) - [Number](https://help.sigmacomputing.com/docs/number.md) - [Text](https://help.sigmacomputing.com/docs/text.md) - [Variant](https://help.sigmacomputing.com/docs/variant.md) - [CumeDist](https://help.sigmacomputing.com/docs/cumedist.md) - [CumulativeAvg](https://help.sigmacomputing.com/docs/cumulativeavg.md) - [CumulativeCorr](https://help.sigmacomputing.com/docs/cumulativecorr.md) - [CumulativeCount](https://help.sigmacomputing.com/docs/cumulativecount.md) - [CumulativeMax](https://help.sigmacomputing.com/docs/cumulativemax.md) - [CumulativeMin](https://help.sigmacomputing.com/docs/cumulativemin.md) - [CumulativeStdDev](https://help.sigmacomputing.com/docs/cumulativestddev.md) - [CumulativeSum](https://help.sigmacomputing.com/docs/cumulativesum.md) - [CumulativeVariance](https://help.sigmacomputing.com/docs/cumulativevariance.md) - [FillDown](https://help.sigmacomputing.com/docs/filldown.md) - [First](https://help.sigmacomputing.com/docs/first.md) - [FirstNonNull](https://help.sigmacomputing.com/docs/firstnonnull.md) - [Window functions](https://help.sigmacomputing.com/docs/window-functions.md) - [Lag](https://help.sigmacomputing.com/docs/lag.md) - [Last](https://help.sigmacomputing.com/docs/last.md) - [LastNonNull](https://help.sigmacomputing.com/docs/lastnonnull.md) - [Lead](https://help.sigmacomputing.com/docs/lead.md) - [MovingAvg](https://help.sigmacomputing.com/docs/movingavg.md) - [MovingCorr](https://help.sigmacomputing.com/docs/movingcorr.md) - [MovingCount](https://help.sigmacomputing.com/docs/movingcount.md) - [MovingMax](https://help.sigmacomputing.com/docs/movingmax.md) - [MovingMin](https://help.sigmacomputing.com/docs/movingmin.md) - [MovingStddev](https://help.sigmacomputing.com/docs/movingstddev.md) - [MovingSum](https://help.sigmacomputing.com/docs/movingsum.md) - [MovingVariance](https://help.sigmacomputing.com/docs/movingvariance.md) - [Nth](https://help.sigmacomputing.com/docs/nth.md) - [Ntile](https://help.sigmacomputing.com/docs/ntile.md) - [Rank](https://help.sigmacomputing.com/docs/rank.md) - [RankDense](https://help.sigmacomputing.com/docs/rankdense.md) - [RankPercentile](https://help.sigmacomputing.com/docs/rankpercentile.md) - [RowNumber](https://help.sigmacomputing.com/docs/rownumber.md) - [VisibilityLimit](https://help.sigmacomputing.com/docs/visibilitylimit.md) - [Use metrics in a workbook](https://help.sigmacomputing.com/docs/use-metrics-in-a-workbook.md) - [Operators overview](https://help.sigmacomputing.com/docs/operators-overview.md) - [Perform AI queries](https://help.sigmacomputing.com/docs/perform-ai-queries.md) - [Use AI with formulas](https://help.sigmacomputing.com/docs/use-ai-with-formulas.md) - [Area charts](https://help.sigmacomputing.com/docs/area-charts.md) - [Box and whisker charts](https://help.sigmacomputing.com/docs/box-and-whisker-charts.md) - [Build a bar chart](https://help.sigmacomputing.com/docs/build-a-bar-chart.md) - [Build a funnel chart](https://help.sigmacomputing.com/docs/build-a-funnel-chart.md) - [Build a gauge chart](https://help.sigmacomputing.com/docs/build-a-gauge-chart.md) - [Build a geography map](https://help.sigmacomputing.com/docs/build-a-geography-map.md) - [Build a KPI chart](https://help.sigmacomputing.com/docs/build-a-kpi-chart.md) - [Build a line chart](https://help.sigmacomputing.com/docs/build-a-line-chart.md) - [Build a progress bar (Beta)](https://help.sigmacomputing.com/docs/build-a-progress-bar.md) - [Build a progress ring (Beta)](https://help.sigmacomputing.com/docs/build-a-progress-ring.md) - [Build a Sankey diagram](https://help.sigmacomputing.com/docs/build-a-sankey-diagram.md) - [Build a scatter plot](https://help.sigmacomputing.com/docs/build-a-scatter-plot.md) - [Build a waterfall chart](https://help.sigmacomputing.com/docs/build-a-waterfall-chart.md) - [Combo charts](https://help.sigmacomputing.com/docs/combo-charts.md) - [Create sparklines in a table](https://help.sigmacomputing.com/docs/create-sparklines-in-a-table.md) - [Maps](https://help.sigmacomputing.com/docs/maps.md) - [Pie and donut charts](https://help.sigmacomputing.com/docs/pie-and-donut-charts.md) - [Add a custom color scale](https://help.sigmacomputing.com/docs/add-a-custom-color-scale.md) - [Add trend lines](https://help.sigmacomputing.com/docs/add-trend-lines.md) - [Configure chart axis marks](https://help.sigmacomputing.com/docs/configure-chart-axis-marks.md) - [Create and format trellis charts](https://help.sigmacomputing.com/docs/create-and-format-trellis-charts.md) - [Customize chart axis range](https://help.sigmacomputing.com/docs/customize-chart-axis-range.md) - [Customize chart background and style](https://help.sigmacomputing.com/docs/customize-chart-background-and-style.md) - [Customize chart mark tooltip fields](https://help.sigmacomputing.com/docs/customize-chart-mark-tooltip-fields.md) - [Display chart data labels](https://help.sigmacomputing.com/docs/display-chart-data-labels.md) - [Display chart reference marks](https://help.sigmacomputing.com/docs/display-chart-reference-marks.md) - [Format chart axis position](https://help.sigmacomputing.com/docs/format-chart-axis-position.md) - [Format chart legend](https://help.sigmacomputing.com/docs/format-chart-legend.md) - [Intro to charts](https://help.sigmacomputing.com/docs/intro-to-visualizations.md) - [Connect to AlloyDB](https://help.sigmacomputing.com/docs/connect-to-alloydb.md) - [Connect to Azure SQL Database](https://help.sigmacomputing.com/docs/connect-to-azure-sql-database.md) - [Connect to BigQuery with OAuth (Beta)](https://help.sigmacomputing.com/docs/connect-to-bigquery-oauth.md) - [Connect to BigQuery](https://help.sigmacomputing.com/docs/connect-to-bigquery.md) - [Connect to ClickHouse (Beta)](https://help.sigmacomputing.com/docs/connect-to-clickhouse.md) - [Connect to Databricks with OAuth](https://help.sigmacomputing.com/docs/connect-to-databricks-oauth.md) - [Connect to Databricks](https://help.sigmacomputing.com/docs/connect-to-databricks.md) - [Set up a Databricks connection for Python](https://help.sigmacomputing.com/docs/set-up-a-databricks-connection-for-python.md) - [Connect to data sources](https://help.sigmacomputing.com/docs/connect-to-data-sources.md) - [Connect to MySQL](https://help.sigmacomputing.com/docs/connect-to-mysql.md) - [Connect to PostgreSQL](https://help.sigmacomputing.com/docs/connect-to-postgresql.md) - [Connect to Redshift](https://help.sigmacomputing.com/docs/connect-to-redshift.md) - [Connect to Snowflake with OAuth](https://help.sigmacomputing.com/docs/connect-to-snowflake-oauth.md) - [Connect to Snowflake](https://help.sigmacomputing.com/docs/connect-to-snowflake.md) - [Restore input table access for a Snowflake connection or user](https://help.sigmacomputing.com/docs/restore-input-table-access-for-a-snowflake-connection-or-user.md) - [Set up a Snowflake connection for Python](https://help.sigmacomputing.com/docs/set-up-a-snowflake-connection-for-python.md) - [Specify session variables for a Snowflake connection (Beta)](https://help.sigmacomputing.com/docs/specify-session-variables-for-a-snowflake-connection.md) - [Connect to SQL Server 2022 and Azure SQL Managed Instance](https://help.sigmacomputing.com/docs/connect-to-sql-server-2022.md) - [Connect to Starburst](https://help.sigmacomputing.com/docs/connect-to-starburst.md) - [About OAuth with write access](https://help.sigmacomputing.com/docs/configure-oauth-with-write-access.md) - [Run a workbook with service account credentials](https://help.sigmacomputing.com/docs/run-a-workbook-with-service-account-credentials.md) - [Connect through SSH](https://help.sigmacomputing.com/docs/connect-through-ssh.md) - [Dynamically assign roles used by a connection](https://help.sigmacomputing.com/docs/dynamically-assign-roles-used-by-a-connection.md) - [AWS PrivateLink Connections](https://help.sigmacomputing.com/docs/aws-privatelink-connections.md) - [Azure Private Link Connections](https://help.sigmacomputing.com/docs/azure-private-link-connections.md) - [GCP Private Service Connect](https://help.sigmacomputing.com/docs/gcp-private-link-connections.md) - [Set up write access](https://help.sigmacomputing.com/docs/set-up-write-access.md) - [Troubleshoot input table connection issues](https://help.sigmacomputing.com/docs/troubleshoot-input-table-connection-issues.md) - [Troubleshoot your connection](https://help.sigmacomputing.com/docs/troubleshoot-your-connection.md) - [Button elements](https://help.sigmacomputing.com/docs/button-elements.md) - [Image elements](https://help.sigmacomputing.com/docs/image-elements.md) - [Intro to UI elements](https://help.sigmacomputing.com/docs/intro-to-ui-elements.md) - [Text elements](https://help.sigmacomputing.com/docs/text-elements.md) - [Value lists](https://help.sigmacomputing.com/docs/value-lists.md) - [Customize the sort order of data elements](https://help.sigmacomputing.com/docs/configure-custom-sort.md) - [Customize element background and styles](https://help.sigmacomputing.com/docs/customize-element-background-and-styles.md) - [Customize element title](https://help.sigmacomputing.com/docs/customize-element-title.md) - [Limit displayed values in a data element](https://help.sigmacomputing.com/docs/limit-displayed-values-in-a-data-element.md) - [Workbook settings overview](https://help.sigmacomputing.com/docs/workbook-settings-overview.md) - [Configure plugins to work with actions](https://help.sigmacomputing.com/docs/configure-plugins-to-work-with-actions.md) - [Develop plugins for Sigma](https://help.sigmacomputing.com/docs/develop-plugins-for-sigma.md) - [Get started with custom plugins](https://help.sigmacomputing.com/docs/get-started-with-custom-plugins.md) - [Plugin development API](https://help.sigmacomputing.com/docs/plugin-development-api.md) - [Plugin examples](https://help.sigmacomputing.com/docs/plugin-examples.md) - [About the Sigma REST API](https://help.sigmacomputing.com/docs/get-started-with-sigmas-api.md) - [Configure a shareable link for an embed](https://help.sigmacomputing.com/docs/configure-a-shareable-link-for-an-embed.md) - [Inbound event reference](https://help.sigmacomputing.com/docs/inbound-event-reference.md) - [Implement inbound and outbound events in embeds](https://help.sigmacomputing.com/docs/inbound-and-outbound-events-in-embeds.md) - [Outbound event reference](https://help.sigmacomputing.com/docs/outbound-event-reference.md) - [Manage iframes for embeds](https://help.sigmacomputing.com/docs/manage-iframes-for-embeds.md) - [Embed Sigma Assistant](https://help.sigmacomputing.com/docs/embed-assistant.md) - [Restrict access to data in embedded content](https://help.sigmacomputing.com/docs/restrict-access-to-data-in-embedded-content.md) - [Embed SDK for React](https://help.sigmacomputing.com/docs/embed-sdk-for-react.md) - [Common embed error codes and messages](https://help.sigmacomputing.com/docs/common-embed-error-codes-and-messages.md) - [Create a secure embed](https://help.sigmacomputing.com/docs/create-a-secure-embed.md) - [Create an embed API with JSON Web Tokens](https://help.sigmacomputing.com/docs/create-an-embed-api-with-json-web-tokens.md) - [Embed URL parameters](https://help.sigmacomputing.com/docs/embed-url-parameters.md) - [Generate embed client credentials](https://help.sigmacomputing.com/docs/generate-embed-client-credentials.md) - [JSON web token claims reference](https://help.sigmacomputing.com/docs/json-web-token-claims-reference.md) - [Manage access to a secure embed](https://help.sigmacomputing.com/docs/manage-access-to-a-secure-embed.md) - [URL encoding reference for parameters](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters.md) - [Test an embed URL in the embed sandbox](https://help.sigmacomputing.com/docs/test-an-embed-url-in-the-embed-sandbox.md) - [Intro to embedded analytics](https://help.sigmacomputing.com/docs/intro-to-embedded-analytics.md) - [Create and manage tenant organizations (Beta)](https://help.sigmacomputing.com/docs/create-and-manage-tenant-organizations.md) - [Deploy content from one tenant organization to one or more tenants (Beta)](https://help.sigmacomputing.com/docs/deploy-content-from-one-tenant-to-other-tenants.md) - [Deploy content from a parent organization to one or more tenants (Beta)](https://help.sigmacomputing.com/docs/deploy-content-from-parent-organization-to-tenant-organizations.md) - [Sigma Tenants deployment use cases and examples (Beta)](https://help.sigmacomputing.com/docs/deployment-use-cases-and-examples.md): Explore end-to-end examples for deploying content to tenant organizations in different scenarios, including SDLC workflows, business unit collaboration, customer tenants, and data sovereignty compliance. - [Embed content from a tenant organization (Beta)](https://help.sigmacomputing.com/docs/embed-content-from-a-tenant-organization.md) - [Deploy content to tenant organizations (Beta)](https://help.sigmacomputing.com/docs/deploy-content-to-tenant-organizations.md) - [Manage content deployed in tenant organizations (Beta)](https://help.sigmacomputing.com/docs/manage-deployed-content.md) - [Sigma Tenants (Beta)](https://help.sigmacomputing.com/docs/multitenancy-at-sigma.md) - [Create and manage a public embed](https://help.sigmacomputing.com/docs/create-and-manage-a-public-embed.md) - [Filter data in data elements](https://help.sigmacomputing.com/docs/data-element-filters.md) - [Sort filter and control values](https://help.sigmacomputing.com/docs/sort-filter-values.md) - [Dynamically filter and modify data in Sigma](https://help.sigmacomputing.com/docs/dynamically-filter-and-modify-data-in-sigma.md) - [Create and configure a file upload control (Beta)](https://help.sigmacomputing.com/docs/create-and-configure-a-file-upload-control.md) - [Create and configure a legend control](https://help.sigmacomputing.com/docs/create-and-configure-a-legend-control.md) - [Create and manage a control element](https://help.sigmacomputing.com/docs/create-and-manage-a-control-element.md) - [Drill down control](https://help.sigmacomputing.com/docs/drill-down-control.md) - [Intro to control elements](https://help.sigmacomputing.com/docs/intro-to-control-elements.md) - [Create and configure a segmented control](https://help.sigmacomputing.com/docs/segmented-control.md) - [Top N filter](https://help.sigmacomputing.com/docs/top-n-filter.md) - [Reference control values as parameters](https://help.sigmacomputing.com/docs/parameters-in-workbooks.md) - [Synced controls](https://help.sigmacomputing.com/docs/synced-controls.md) - [Set control values in a URL using query string parameters](https://help.sigmacomputing.com/docs/workbook-control-values-in-the-url.md) - [Ask a question about a data source table](https://help.sigmacomputing.com/docs/ask-data-source.md) - [Ask natural language queries with Sigma Assistant](https://help.sigmacomputing.com/docs/ask-natural-language-queries-with-assistant.md) - [Capture and annotate images in comments](https://help.sigmacomputing.com/docs/annotate-element-images-as-comments.md) - [Use comments in workbooks](https://help.sigmacomputing.com/docs/workbook-comments.md) - [Drill down into data](https://help.sigmacomputing.com/docs/drill-into-data.md) - [Explain charts with AI](https://help.sigmacomputing.com/docs/explain-visualizations-with-ai.md) - [Highlight chart values](https://help.sigmacomputing.com/docs/highlight-chart-values.md) - [View underlying data](https://help.sigmacomputing.com/docs/view-underlying-data.md) - [Install skills for AI assistants](https://help.sigmacomputing.com/docs/install-skills-for-ai-assistants.md) - [Use the Sigma MCP Server](https://help.sigmacomputing.com/docs/use-sigma-mcp-server.md) - [Choose your Snowflake role for an OAuth connection](https://help.sigmacomputing.com/docs/choose-snowflake-role.md) - [Create and interact with custom views](https://help.sigmacomputing.com/docs/create-and-interact-with-custom-views.md) - [Create and share saved views](https://help.sigmacomputing.com/docs/create-and-share-saved-views.md) - [Find a specific value in a table or input table (Beta)](https://help.sigmacomputing.com/docs/find-a-value-in-a-table.md) - [Keyboard shortcuts: Mac OS](https://help.sigmacomputing.com/docs/keyboard-shortcuts-mac-os.md) - [Keyboard shortcuts: Microsoft Windows](https://help.sigmacomputing.com/docs/keyboard-shortcuts-microsoft-windows.md) - [View column details](https://help.sigmacomputing.com/docs/view-column-details.md) - [Set up an app for two-factor authentication](https://help.sigmacomputing.com/docs/app-based-authentication-for-users.md) - [Refresh your connection sign-in sessions](https://help.sigmacomputing.com/docs/refresh-connection-sign-in-sessions.md) - [Search for content in your organization](https://help.sigmacomputing.com/docs/search-in-sigma.md) - [Examine workbook and data model queries](https://help.sigmacomputing.com/docs/examine-workbook-queries.md) - [Override the Snowflake warehouse used by a workbook](https://help.sigmacomputing.com/docs/override-snowflake-warehouse-workbook.md) - [Create and edit document templates](https://help.sigmacomputing.com/docs/create-and-edit-workbook-templates.md) - [Create documents from templates](https://help.sigmacomputing.com/docs/create-workbooks-from-templates.md) - [Add context with a document description](https://help.sigmacomputing.com/docs/add-context-with-document-descriptions.md) - [About version tags to workbooks, data models, and reports](https://help.sigmacomputing.com/docs/add-version-tags-to-workbooks-and-data-models.md) - [Tag a workbook, data model, or report version](https://help.sigmacomputing.com/docs/tag-a-document-version.md) - [Use input tables with version tagging](https://help.sigmacomputing.com/docs/use-input-tables-with-version-tagging.md) - [Use warehouse views with version tagging](https://help.sigmacomputing.com/docs/use-warehouse-views-with-version-tagging.md) - [View and manage document badges](https://help.sigmacomputing.com/docs/view-and-manage-document-badges.md) - [Workbook lifecycle: explore, draft, and publish](https://help.sigmacomputing.com/docs/workbook-lifecycle-explore-draft-and-publish.md) - [Workbook versions and version history](https://help.sigmacomputing.com/docs/workbook-versions-and-version-history.md) - [Add shortcuts to documents](https://help.sigmacomputing.com/docs/add-shortcuts-to-documents.md) - [Change the data source for a workbook, data model, or element](https://help.sigmacomputing.com/docs/change-the-data-source-for-a-workbook-data-model-or-element.md) - [Manage workbook localization](https://help.sigmacomputing.com/docs/manage-workbook-localization.md) - [Add custom page panels to a workbook](https://help.sigmacomputing.com/docs/add-custom-page-panels-to-a-workbook.md) - [Manage workbook page visibility](https://help.sigmacomputing.com/docs/manage-workbook-page-visibility.md) - [Workbook page settings overview](https://help.sigmacomputing.com/docs/workbook-page-settings-overview.md) - [View workbook and data model data lineage](https://help.sigmacomputing.com/docs/workbook-data-lineage.md) - [Manage workbook refresh options](https://help.sigmacomputing.com/docs/workbook-refresh-options.md) - [Best practices for improved document performance](https://help.sigmacomputing.com/docs/best-practices-for-improved-performance.md): If your document, such as a workbook, is slow to load data elements, Sigma provides several options to accelerate the performance of your document. - [Caching and data freshness](https://help.sigmacomputing.com/docs/caching-and-data-freshness.md) - [Configure data loading (Beta)](https://help.sigmacomputing.com/docs/configure-data-loading.md) - [Create and manage warehouse views](https://help.sigmacomputing.com/docs/create-and-manage-workbook-warehouse-views.md) - [Manage universal result cache (Beta)](https://help.sigmacomputing.com/docs/manage-universal-result-cache.md) - [About materialization](https://help.sigmacomputing.com/docs/materialization.md) - [Schedule materialization for a data model or workbook (Beta)](https://help.sigmacomputing.com/docs/schedule-materialization-for-a-data-model-or-workbook.md) - [Schedule materialization for a version-tagged data model](https://help.sigmacomputing.com/docs/schedule-materialization-for-a-version-tagged-data-model.md) - [Set a query ID cache duration](https://help.sigmacomputing.com/docs/set-a-query-id-cache-duration.md) - [Create and manage metrics](https://help.sigmacomputing.com/docs/create-and-manage-metrics.md) - [About metrics](https://help.sigmacomputing.com/docs/about-metrics.md) - [Supported data types and formats](https://help.sigmacomputing.com/docs/data-types-and-formats.md) - [Upload CSV data](https://help.sigmacomputing.com/docs/upload-csv-data.md) - [Create and manage data models](https://help.sigmacomputing.com/docs/create-and-manage-data-models.md) - [Define relationships in data models](https://help.sigmacomputing.com/docs/define-relationships-in-data-models.md) - [Manage AI context for a data model (Beta)](https://help.sigmacomputing.com/docs/manage-ai-context-for-data-models.md) - [Navigate data models](https://help.sigmacomputing.com/docs/navigate-data-models.md) - [Validate content in a data model](https://help.sigmacomputing.com/docs/validate-content-data-model.md) - [Configure column-level security](https://help.sigmacomputing.com/docs/column-level-security.md) - [Set up row-level security](https://help.sigmacomputing.com/docs/set-up-row-level-security.md) - [Data modeling best practices](https://help.sigmacomputing.com/docs/data-modeling-best-practices.md) - [Tutorial: Intro to data models](https://help.sigmacomputing.com/docs/data-modeling-tutorial.md) - [Get started with data modeling](https://help.sigmacomputing.com/docs/get-started-with-data-modeling.md) - [Create and edit joins in data models and workbooks](https://help.sigmacomputing.com/docs/create-and-edit-joins-in-data-models-and-workbooks.md) - [Create and edit unions](https://help.sigmacomputing.com/docs/create-and-edit-unions.md) - [Overview of joining data](https://help.sigmacomputing.com/docs/joins-overview.md) - [Review and manage your data catalog](https://help.sigmacomputing.com/docs/manage-data-catalog.md) - [Migrate a dataset to a data model](https://help.sigmacomputing.com/docs/migrate-a-dataset-to-a-data-model.md) - [Define custom datetime formats](https://help.sigmacomputing.com/docs/define-custom-datetime-formats.md) - [Generate and access structured objects](https://help.sigmacomputing.com/docs/generate-and-access-structured-objects.md) - [Download and export limitations](https://help.sigmacomputing.com/docs/download-export-and-upload-limitations.md) - [Download workbook data](https://help.sigmacomputing.com/docs/download-workbook-data.md) - [Export as email burst](https://help.sigmacomputing.com/docs/export-as-email-burst.md) - [Export to cloud storage](https://help.sigmacomputing.com/docs/export-to-cloud-storage.md) - [Format an email message](https://help.sigmacomputing.com/docs/format-an-email-message.md) - [Export to email](https://help.sigmacomputing.com/docs/export-to-email.md) - [Export to Google Drive](https://help.sigmacomputing.com/docs/export-to-google-drive.md) - [Export to Google Sheets](https://help.sigmacomputing.com/docs/export-to-google-sheets.md) - [Export to Microsoft SharePoint](https://help.sigmacomputing.com/docs/export-to-microsoft-sharepoint.md) - [Format a Microsoft Teams message](https://help.sigmacomputing.com/docs/format-a-microsoft-teams-message.md) - [Export to Microsoft Teams](https://help.sigmacomputing.com/docs/export-to-microsoft-teams.md) - [Format a Slack message](https://help.sigmacomputing.com/docs/format-a-slack-message.md) - [Export to Slack](https://help.sigmacomputing.com/docs/export-to-slack.md) - [Export to webhook](https://help.sigmacomputing.com/docs/export-to-webhook.md) - [Schedule a conditional export or alert](https://help.sigmacomputing.com/docs/schedule-a-conditional-export-or-alert.md) - [Configure additional options for exports](https://help.sigmacomputing.com/docs/configure-additional-options-for-exports.md) - [Manage scheduled exports](https://help.sigmacomputing.com/docs/manage-scheduled-exports.md) - [Send or schedule workbook exports](https://help.sigmacomputing.com/docs/send-or-schedule-workbook-exports.md) - [Share a folder](https://help.sigmacomputing.com/docs/share-a-folder.md) - [Share a workbook, data model, or report](https://help.sigmacomputing.com/docs/share-a-workbook.md) - [Share and accept cross-org document templates](https://help.sigmacomputing.com/docs/share-and-accept-cross-org-workbook-templates.md) - [Share document templates](https://help.sigmacomputing.com/docs/share-workbook-templates.md) - [About billable usage events](https://help.sigmacomputing.com/docs/about-billable-usage-events.md) - [Get around in Sigma](https://help.sigmacomputing.com/docs/get-around-in-sigma.md) - [About Sigma](https://help.sigmacomputing.com/docs/about-sigma.md) - [Sigma basics](https://help.sigmacomputing.com/docs/sigma-basics.md): This document introduces you to some basic concepts and terminology used in Sigma. - [Get started with AI in Sigma](https://help.sigmacomputing.com/docs/getting-started-with-ai.md) - [Start using Sigma](https://help.sigmacomputing.com/docs/start-using-sigma.md) - [Sigma Public](https://help.sigmacomputing.com/docs/sigma-public.md) - [Get started with workbook templates](https://help.sigmacomputing.com/docs/get-started-with-workbook-templates.md) - [HubSpot Campaign Analysis template](https://help.sigmacomputing.com/docs/hubspot-campaign-creator-template.md) - [Snowflake usage templates](https://help.sigmacomputing.com/docs/snowflake-usage-templates.md) - [Sigma's sample connection](https://help.sigmacomputing.com/docs/sigmas-sample-connection.md) - [Supported regions, data platforms, and features](https://help.sigmacomputing.com/docs/region-warehouse-and-feature-support.md) - [Sigma product releases](https://help.sigmacomputing.com/docs/sigma-product-releases.md) - [About Sigma RADAR](https://help.sigmacomputing.com/docs/about-sigma-radar.md) - [Escalate critical issues](https://help.sigmacomputing.com/docs/escalate-critical-issues.md) - [Sigma support](https://help.sigmacomputing.com/docs/sigma-support.md) - [Submit a support request](https://help.sigmacomputing.com/docs/submit-a-support-request.md) - [Access Sigma documentation from AI tools](https://help.sigmacomputing.com/docs/use-documentation-mcp-server.md) - [Learn Sigma](https://help.sigmacomputing.com/docs/learn-sigma.md) - [Sigma Fundamentals for Builders](https://help.sigmacomputing.com/docs/sigma-fundamentals-for-builders.md) - [Lesson eight: Input tables and combining data](https://help.sigmacomputing.com/docs/lesson-eight-input-tables-and-combining-data.md) - [Lesson five: Controls and actions](https://help.sigmacomputing.com/docs/lesson-five-controls-and-actions.md) - [Lesson four: Charts and visualizations](https://help.sigmacomputing.com/docs/lesson-four-charts-and-visualizations.md) - [Lesson one: Basic organization and navigation](https://help.sigmacomputing.com/docs/lesson-one-basic-organization-and-navigation.md) - [Lesson seven: Style](https://help.sigmacomputing.com/docs/lesson-seven-style.md) - [Lesson six: Organization](https://help.sigmacomputing.com/docs/lesson-six-organization.md) - [Lesson three: Grouped tables and pivot tables](https://help.sigmacomputing.com/docs/lesson-three-grouped-tables-and-pivot-tables.md) - [Lesson two: Working with data tables](https://help.sigmacomputing.com/docs/lesson-two-working-with-data-tables.md) ## API Reference - [Delete an account type](https://help.sigmacomputing.com/reference/deleteaccounttype.md): Delete a custom account type and reassign its users to another account type. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Default Sigma account types cannot be deleted. - All users assigned to the deleted account type will be reassigned to the specified **reassignToAccountTypeId**. - Retrieve account type IDs by calling the [/v2/accountTypes](listaccounttypes) endpoint. ### Usage scenarios - Remove custom account types that are no longer needed. - Consolidate account types by moving users to a different account type before deletion. - [List account type permissions](https://help.sigmacomputing.com/reference/listaccounttypepermissions.md): Returns all feature permissions for a specific account type. ### Usage notes - Retrieve the **accountTypeId** by calling the [/v2/accountTypes](listaccounttypes) endpoint. - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. ### Usage scenarios - Display permission details in an admin interface. - Validate user capabilities based on account type. - Compare permissions across different account types. - [Create an account type](https://help.sigmacomputing.com/reference/createaccounttype.md): Create a custom account type with specified permissions. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Use the permission names from the [/v2/accountTypes/:accountTypeId/permissions](listaccounttypepermissions) endpoint. ### Usage scenarios - Create custom account types to define specific permission sets for your organization's users. - [List account types](https://help.sigmacomputing.com/reference/listaccounttypes.md): Returns a list of all account types available in the organization. ### Usage notes - Use the **accountTypeId** with the [/v2/accountTypes/:accountTypeId/permissions](listaccounttypepermissions) endpoint to retrieve more detailed permissions. - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. ### Usage scenarios - Display available account types in an admin interface. - Show an overview of account types for management. - [Create an API connector](https://help.sigmacomputing.com/reference/createapiconnector.md): This endpoint creates a new API connector that defines how to call an external HTTP endpoint from within Sigma. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled. - If a credential is provided using the `authId` parameter, the user making this request must have at least **Can view** permission on the credential and the request URL must match the credential's allowlist. - Retrieve the **apiCredentialId** (used as `authId`) by calling the [/v2/api-credentials](listapicredentials) endpoint. ### Usage scenarios - **Programmatic connector setup:** Automate creation of API connectors as part of an environment provisioning workflow. - **Integration onboarding:** Create connectors for each external service your workbooks need to interact with. - [Delete an API connector](https://help.sigmacomputing.com/reference/deleteapiconnector.md): This endpoint archives an API connector, preventing it from being used in new workbook actions. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](listapiconnectors) endpoint. - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and must have **Can edit** access to the connector. ### Usage scenarios - **Cleanup:** Remove connectors that are no longer in use to keep the organization's connector list tidy. - **Decommissioning:** Archive connectors associated with deprecated or retired external services. - [Get an API connector](https://help.sigmacomputing.com/reference/getapiconnector.md): This endpoint returns full details for a single API connector, including its request parameters and configuration. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - Only returns API connectors that the user making this request has at least **Can view** access to. - Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](listapiconnectors) endpoint. ### Usage scenarios - **Connector inspection:** Retrieve the full configuration of a connector for display or validation before use. - **Connector duplication:** Read an existing connector's configuration to use as the basis for a new one. - [List API connectors](https://help.sigmacomputing.com/reference/listapiconnectors.md): This endpoint returns a paginated list of API connectors. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - Only returns API connectors that the user making this request has at least **Can view** access to. - Use the `name` query parameter to filter by connector name. - Use the `orderBy` query parameter to set sort order. ### Usage scenarios - **Connector discovery:** Retrieve a list of available API connectors available to users configuring **Call API** actions. - **Connector management:** View and audit the organization's API connectors. - [Update an API connector](https://help.sigmacomputing.com/reference/updateapiconnector.md): This endpoint updates one or more fields on an existing API connector. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](listapiconnectors) endpoint. - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and must have **Can edit** access to the connector. - Omitted fields are left unchanged. Pass `null` for `authId` to remove the credential association. ### Usage scenarios - **Endpoint migration:** Update the connector URL or parameters when an external API changes its interface. - **Credential rotation:** Rebind the connector to a new credential after rotating secrets. - [Create an API credential](https://help.sigmacomputing.com/reference/createapicredential.md): This endpoint creates a new API credential for use with API connectors and the **Call API** action in Sigma. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled. - The `allowlist` parameter is required and must contain at least one hostname glob pattern. Use `["*"]` to allow the credential to be used against any host. - The following authentication methods are supported: `basic`, `bearer`, `apiKey`, `oAuthClientCredentials`, `oAuthAuthorizationCode`, `oAuthPasswordCredentials`, `awsSigV4`. - Secret fields are encrypted at rest and are never returned in subsequent read responses. ### Usage scenarios - **Credential provisioning:** Automate credential creation as part of environment setup or onboarding. - **Multi-service authentication:** Create separate credentials for each external service, with allowlists scoped to only that service's domains. - [Delete an API credential](https://help.sigmacomputing.com/reference/deleteapicredential.md): This endpoint archives an API credential so it can no longer be associated with new API connectors. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and have **Can edit** access to the API credential. - Retrieve the **apiCredentialId** by calling the [/v2/api-credentials](listapicredentials) endpoint. - Archiving a credential does not automatically unbind any API connectors that reference it. ### Usage scenarios - **Credential decommissioning:** Remove credentials for decommissioned services or expired tokens. - **Security cleanup:** Archive compromised or rotated credentials to prevent accidental reuse. - [Get an API credential](https://help.sigmacomputing.com/reference/getapicredential.md): This endpoint returns nonsensitive details for a single API credential. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and have at least **Can view** access on the credential. - Retrieve the **apiCredentialId** by calling the [/v2/api-credentials](listapicredentials) endpoint. - Secret fields (passwords, tokens, client secrets, secret access keys) are never returned. ### Usage scenarios - **Credential inspection:** Retrieve the configuration of a credential to verify its settings before using it with a connector. - [List API credentials](https://help.sigmacomputing.com/reference/listapicredentials.md): This endpoint returns a paginated list of API credentials. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled. - Only returns [API credentials](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma#add-a-new-api-credential-to-sigma) that the user making this request has at least **Can view** access to. - Secret fields such as passwords, tokens, and client secrets are never included in the response. - Use the `name` query parameter to filter by credential name. - Use the `orderBy` query parameter to set sort order. ### Usage scenarios - **Credential management:** View and audit the credentials used by API connectors in your Sigma organization. - **API connector creation:** Retrieve available credentials to present as options when creating an API connector. - [Update an API credential](https://help.sigmacomputing.com/reference/updateapicredential.md): This endpoint updates one or more fields on an existing API credential. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and have **Can edit** access to the API credential. - Retrieve the **apiCredentialId** by calling the [/v2/api-credentials](listapicredentials) endpoint. - Omitted fields are left unchanged. - If a `credential` is provided, the provided authentication details (ID, secret, etc.) replace the previous values. To leave secrets unchanged, omit the `credential` parameter. ### Usage scenarios - **Secret rotation:** Update the secret fields for a credential automatically for an external service. - **Allowlist updates:** Expand or restrict the set of hostnames the credential can be used against. - [Get access token](https://help.sigmacomputing.com/reference/posttoken.md): Use your Sigma client ID and secret with this endpoint to generate an access token valid for one hour, or to refresh your token. You can then use the access token to authenticate requests made to the Sigma API. To make any API call with the Sigma API, including calls from the API documentation, you must have a valid bearer token. To generate a token, you must have a valid **Client ID** and **Secret**. See [Generate Sigma API client credentials](generate-client-credentials). You make all API calls to a specific URL that corresponds to the cloud where your Sigma environment is hosted. Set the **Base URL** to the relevant URL for your environment. For details, see [Identify your API request URL](get-started-sigma-api#identify-your-api-request-url). Generate a token by sending a POST request to this `/v2/auth/token` endpoint, or use the **Try It!** option on this page. ### Usage notes - The API token is valid for 1 hour. When the token expires, an endpoint response returns an unauthorized error. - Refresh your access token before it expires using the `refresh_token` option. - If your client credentials are owned by a user assigned the Admin account type, you can generate an access token as a specific user using impersonation. - [Add grants to a connection](https://help.sigmacomputing.com/reference/createconnectiongrant.md): Add grants to grant permissions on a connection to specific users or teams. ### Usage notes - See [Data permissions overview](https://help.sigmacomputing.com/docs/data-permissions-overview) for details about permissions that can be granted on a connection. - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - Specify the team or user IDs to grant permissions: - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. ### Usage scenarios - Grant a specific team `Can use` access to a connection. - [Delete a grant for a connection](https://help.sigmacomputing.com/reference/deleteconnectiongrant.md): Deletes a specific permission granted on a specific connection. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. ### Usage scenarios - **Principle of least privilege**: Reduce the permissions granted to specific users and teams on a connection to only what is needed. - **User offboarding**: Remove connection permissions granted to a user that will be deactivated. - [List grants for a connection](https://help.sigmacomputing.com/reference/listconnectiongrants.md): Get a list of permissions granted to users or teams on a specific connection. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - [Delete a connection](https://help.sigmacomputing.com/reference/deleteconnection.md): Delete a specific connection by connection ID. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - [Get connection details](https://help.sigmacomputing.com/reference/getconnection.md): Get the metadata of a specific connection by connection ID. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - [Add dbt metadata for a connection](https://help.sigmacomputing.com/reference/postconnectiondbtartifacts.md): Add dbt run artifacts for a given connection. For more details, see [Configure dbt Core integration](doc:manage-dbt-integration#configure-dbt-core-integration-beta). ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - Create a tar.gz file containing the target directory of your dbt project that contains run artifacts. - Provide the file in the request with the field name 'artifacts'. - [Test a connection](https://help.sigmacomputing.com/reference/testconnection.md): Test whether an existing connection allows read and write operations for the user associated with the API credentials. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - [Update a connection](https://help.sigmacomputing.com/reference/updateconnection.md): Update a specific connection by connection ID. When updating the connection, send any connection details that you want to keep. Retrieve the current state of a connection by calling the [/v2/connections/{connectionId}](getconnection) endpoint. ### Usage notes - To restore a deleted connection, pass the `restore` parameter. - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - [Update a connection](https://help.sigmacomputing.com/reference/updateconnectiondeprecated.md): Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the [PUT endpoint](https://help.sigmacomputing.com/reference/updateconnection). - [Create a connection](https://help.sigmacomputing.com/reference/createconnection.md): Create a connection to a cloud data warehouse from Sigma. For additional details, see [Connect to data sources](https://help.sigmacomputing.com/docs/connect-to-data-sources). - [List connections](https://help.sigmacomputing.com/reference/listconnections.md): Get a list of available connections and the connection IDs. - [Get connection path for a table](https://help.sigmacomputing.com/reference/getinodeconnectionpath.md): Get the connection path for a specific table. If the inodeId is not for a table, this endpoint returns an error. ### Usage notes - Retrieve the **inodeId** by calling the [/v2/workbooks/{workbookId}/sources](getworkbooksources) or [/v2/datasets/{datasetId}/source](getdatasetsources) endpoint. - [List connection paths](https://help.sigmacomputing.com/reference/listconnectionpaths.md): List all paths for all connections available to the user. ### Usage notes - Call this endpoint to retrieve the specific databases, catalogs, schemas, and tables available to the user associated with the API credentials. - [List columns for a warehouse table](https://help.sigmacomputing.com/reference/listconnectiontablecolumns.md): Returns column names, types, and other details for a table in a data warehouse connection. ### Usage notes - Retrieve the **tableId** by first calling the [/v2/connections/paths](listconnectionpaths) endpoint to discover available paths, then calling the [/v2/connection/{connectionId}/lookup](lookupconnection) endpoint with the path to the desired table and using the `inodeId` included in the response. - [Look up connections by path](https://help.sigmacomputing.com/reference/lookupconnection.md): This endpoint returns details about the fully qualified path to an object in a specific connection by connection ID. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. Different connections support different paths: - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path. - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path. - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path. Connection path details include the connection path ID, called the `inodeId` in the response, and the type of object in the connection path, either a table or a scope (database, schema, catalog, or other higher-level object). - [Add grants to a connection path](https://help.sigmacomputing.com/reference/createconnectionpathgrant.md): Add a grant to a specific connection path to grant permissions for users or teams. ### Usage notes - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](lookupconnection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](listconnectionpaths) endpoint and using the `urlId` included in the response. - Specify the team or user IDs to grant permissions: - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Delete a grant for a connection path](https://help.sigmacomputing.com/reference/deleteconnectionpathgrant.md): Delete a specific permission granted to a specific connection path for a user or team. ### Usage notes - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](lookupconnection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](listconnectionpaths) endpoint and using the `urlId` included in the response. - Retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](listconnectionpathgrants) endpoint. - [List grants for a connection path](https://help.sigmacomputing.com/reference/listconnectionpathgrants.md): Get a list of permissions granted to a specific connection path. ### Usage notes - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](lookupconnection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](listconnectionpaths) endpoint and using the `urlId` included in the response. - [Sync a connection by path](https://help.sigmacomputing.com/reference/syncconnectionpath.md): Sync the connection for a data source to retrieve any changes from the data warehouse. ### Usage notes - Specify the path to a table, stored procedure, schema, or database in your data warehouse that you want to sync. To trigger a full connection sync, provide an empty path (`[]`). - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - Different connections support different paths: - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path. - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path. - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path. - [Create API credentials](https://help.sigmacomputing.com/reference/createcredentials.md): Create API client credentials for a given user. To make this request, your API client credentials must be associated with a Sigma admin user for the same Sigma organization. **Important:** The response includes sensitive information. Ensure that you securely store and handle the returned `clientId` and `clientSecret`. These credentials grant access to your Sigma account and should never be exposed publicly or shared unnecessarily. ### Usage Notes: - Retrieve the **ownerId** by calling the [/v2/members](listmembers) endpoint and using the `memberId` included in the response. - [Delete API credentials](https://help.sigmacomputing.com/reference/deletecredentials.md): Revoke the API client credentials associated with a given client ID. To make this request, your API client credentials must be associated with a Sigma admin user for the same Sigma organization. - [Create a data model from a code representation](https://help.sigmacomputing.com/reference/createdatamodelspec.md): This endpoint creates a new data model in Sigma from a code representation. Use it to programmatically define and create data models that are then accessible from the Sigma UI. For more information on managing data models via the Sigma API, see [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code). For more information on using this endpoint, including an end-to-end example, see [Create a data model from a code representation](https://help.sigmacomputing.com/docs/create-a-data-model-from-a-code-representation). ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish data models** permission. - Retrieve a representation of an existing data model by calling the [/v2/dataModels/{dataModelId}/spec](getdatamodelspec) endpoint. - To get a list of folders, call the [/v2/files](fileslist) endpoint and review the `id` field in the response for files with a `type` of `folder`. - The default format of the representation is JSON. To use YAML, add the header `Content-Type: application/yaml`. ### Usage scenarios - **Automation**: If you want to create several data models across one or more organizations, you can use this endpoint to programmatically create the data models. - **Integration**: Using this endpoint, you can create data models based on external data sources or integrate Sigma with other tools and platforms. - **Migration**: You can use this endpoint to migrate data models from one organization to another. - **Version control**: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants. - **Agentic workflows**: Agents can use these endpoints to directly manage data model contents in code. - [Get the code representation of a data model](https://help.sigmacomputing.com/reference/getdatamodelspec.md): This endpoint returns a code representation of an existing data model, including metadata and contents. The response can be formatted as either JSON or YAML, and contains a data model's pages, elements, columns, sources, and more. The representation can be used to store, copy, or modify the data model programmatically. For more information on managing data models via the Sigma API, see [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code). For more information on using this endpoint, including an end-to-end example, see [Get the code representation of a data model](https://help.sigmacomputing.com/docs/get-the-code-representation-of-a-data-model). ### Usage notes - To perform this operation, you must use API credentials owned by a user with **Can view** access to the data model. - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. Invalid or nonexistent IDs return an error. - The response includes the data sources, metadata, and relationships necessary to recreate the data model. The data itself is not included in the response. - To create a new data model from code, use the [/v2/dataModels/spec](createdatamodelspec) endpoint. - To update an existing data model from code, use the [/v2/dataModels/{dataModelId}/spec](updatedatamodelspec) endpoint. - The default format of the representation is JSON. To receive YAML, add the query parameter `?format=yaml` or the header `Accept: application/yaml`. ### Usage scenarios - **Backup and restore**: Developers can use this endpoint to programmatically back up data models and restore them if needed. - **Version control**: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants. - **Administration**: Administrators can use this endpoint to programmatically analyze and govern data models across an organization. - **Migration**: Administrators can use this endpoint to programmatically migrate data models between organizations or tenants. - **Agentic workflows**: Agents can use these endpoints to directly manage data model contents in code. - [Update a data model from a code representation](https://help.sigmacomputing.com/reference/updatedatamodelspec.md): This endpoint replaces a data model with the contents defined in a code representation. You can programmatically update the data model's structure, metadata, and contents. This creates a new version of the data model, which is accessible from the Sigma UI. For more information on managing data models via the Sigma API, see [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code). For more information on using this endpoint, including an end-to-end example, see [Update a data model from a code representation](https://help.sigmacomputing.com/docs/update-a-data-model-from-a-code-representation). ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish data models** permission. - To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model. - Retrieve a representation of an existing data model by calling the [/v2/dataModels/{dataModelId}/spec](getdatamodelspec) endpoint. - To create a new data model from code, use the [/v2/dataModels/spec](createdatamodelspec) endpoint. - The endpoint only supports updates to the `pages` array and its contents. Additional fields are not required and are ignored in the request body. - Partial updates are not supported. You must provide the entire representation of the data model in the request body. - The default format of the representation is JSON. To use YAML, add the header `Content-Type: application/yaml`. ### Usage scenarios - **Automation**: If you want to update several data models across one or more organizations, or in response to external events, you can use this endpoint to programmatically update the data models. - **Integration**: Using this endpoint, you can update data models based on external data sources or integrate Sigma with other tools and platforms. - **Version control**: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants. - **Agentic workflows**: Agents can use these endpoints to directly manage data model contents in code. - [List columns for all elements in a data model](https://help.sigmacomputing.com/reference/getdatamodelcolumns.md): This endpoint retrieves all columns in a data model for all elements in the data model. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. ### Usage scenarios - **Data exploration:** Enable users to explore the data structure of a data model element, facilitating deeper analysis and understanding. - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately. ### Best practices - Use this endpoint when setting up interfaces that require specific knowledge about the data structure. - [Get a materialization job](https://help.sigmacomputing.com/reference/getdatamodelmaterialization.md): This endpoint retrieves details of a specific materialization job. It provides comprehensive information including status, start and completion times, which helps for monitoring and troubleshooting materialization. ### Usage notes - Retrieve the **materializationId** by calling the [/v2/dataModels/materializations](materializedatamodelelement) endpoint. ### Usage scenarios - **Job Monitoring:** Enables administrators to track the progress and status of materialization jobs, aiding in operational oversight. - **Troubleshooting:** Provides detailed information needed to diagnose and resolve issues in materialization processes. ### Best practices - Monitor materialization jobs regularly to detect and resolve issues promptly. - Use the detailed information provided by this endpoint to optimize materialization settings and performance. - [List elements in a data model](https://help.sigmacomputing.com/reference/listdatamodelelements.md): This endpoint retrieves details of all elements in a data model, which helps you understand and interact with the individual components that make up the data model, such as tables or controls. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. - To retrieve elements from version-tagged data models, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/dataModels/{dataModelId}/tags](listdatamodeltags) endpoint and using the `tags.name` included in the response for a given data model. ### Usage scenarios - **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation. - **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with. ### Best practices - Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience. - [List lineage for a data model](https://help.sigmacomputing.com/reference/listdatamodellineagetree.md): This endpoint lists the elements, data sources, and upstream lineage for those data sources in a data model, providing a detailed view of how data is interconnected within a data model. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. ### Usage scenarios - **Data governance:** Allows data managers to track how information is used and propagated through different data model elements. - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or data model structure. - **Data source management**: Identify the dependencies of data sources in use in a specific data model. ### Best practices - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams. - Use this endpoint to regularly audit data model structures, ensuring that all data connections and transformations are correct and optimized. - [List materialization schedules for a data model](https://help.sigmacomputing.com/reference/listdatamodelmaterializationschedules.md): This endpoint retrieves a list of all materialization schedules associated with a data model. Each schedule details when and how often specific data model elements are automatically materialized to optimize performance and data freshness. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. - To retrieve additional pages of results, use the response of the `nextPageToken` parameter as the `pageToken` query parameter in the following request. ### Usage scenarios - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance. - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments. ### Best practices - Regularly review materialization schedules to align them with current data usage patterns and business needs. - Use pagination to manage large sets of data and improve response times of API calls. - [List data model sources](https://help.sigmacomputing.com/reference/listdatamodelsources.md): List data sources of a data model given the dataModelId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. - [List tags for a data model](https://help.sigmacomputing.com/reference/listdatamodeltags.md): Retrieve the version tag information for a specific data model. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. ### Usage scenarios - Provide on-demand performant access to version tag details for a data model. For example, make a GET request to the [/v2/dataModels](listdatamodels) endpoint with the `excludeTags` parameter set to `True` to improve performance, then use this endpoint to return tag information for specific data models. - [Run a scheduled materialization for a data model element](https://help.sigmacomputing.com/reference/materializedatamodelelement.md): This endpoint runs a scheduled materialization for an element in a data model. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance. For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization). ### Usage notes - The materialization schedule for the specified element must be created beforehand. - Retrieve the **sheetId** by calling the [/v2/dataModels/{dataModelId}/materialization-schedules](listdatamodelmaterializationschedules) endpoint. - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. ### Usage scenarios - **Performance optimization:** Use this endpoint to improve response times for frequently accessed data model elements. - **Data refresh:** Allows users to manually (programmatically) refresh the data of specific data model elements to ensure that the latest data is available for analysis and reporting. ### Best practices - Prioritize materialization for elements that are heavily used or form critical components of business reports. - Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times. - [Swap data model sources](https://help.sigmacomputing.com/reference/swapdatamodelsources.md): Swap the data sources used by a data model. You can swap from one connection to another, and/or from one dataset or table to another. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - To map the sources of a specific element, you can use the table or dataset ID: - List sources of data model by calling the [/v2/dataModels/{dataModelId}/sources](listdatamodelsources) endpoint. - Retrieve table and dataset IDs by calling the [/v2/files](fileslist) endpoint. Use the `typeFilters` option to filter for table and dataset files. Use `id` field in the response as the `fromId` or `toId`, as relevant. - To swap all tables in a connection, set the `swapTables` option to `true`. - Use the `paths` option to specify the connection paths to swap. The connection path is a list of strings that represents the path to the table in the cloud data warehouse. For example, `["database", "schema", "table"]`. - If the table schema is the same in both connections, leave the `paths` option empty to swap all tables in the connection. You can also pass a partial path to swap between databases, catalogs, or schemas. - If `sourceMapping` is provided, those mappings take precedence over the connection swaps. - If `swapTables` is not set to `true`, only Custom SQL elements have their connections changed. ### Usage scenarios - **Data model development**: Use a test data source while developing a data model, then swap the source to a production database when ready to share the data model for production use. - [Tag a data model](https://help.sigmacomputing.com/reference/tagdatamodel.md): Add a version tag to a data model and optionally set up a connection to swap to for a specific version of the data model. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. - Retrieve the **tag** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - Retrieve the **connectionId** to use as the **fromId** or **toId** by calling the [/v2/connections](listconnections) endpoint. - If your data model includes a source that is not mapped to a new source, that source is not swapped. - When swapping data models used as the source for the data model: - You can only swap a data model source to another version of the same data model source. You cannot swap a data model source to a table in your data warehouse or a dataset. - When you swap sources from one data model version to a new one, specify the version tag of the data model that you swap to with `toVersionTagId`: - To swap to the latest published version of the data model, specify `toVersionTagId` as `null`. - To swap to a specific tagged version of the data model, specify the `toVersionTagId` of the data model. - If the data model already uses a specific tagged version of a data model as a source, use `fromVersionTagId` to indicate which tagged version to swap from. - To swap from the latest published version of the data model, specify `fromVersionTagId` as `null`. - To swap from a specific tagged version of the data model, specify the `fromVersionTagId` of the data model. - To retrieve the `fromVersionTagId` for a data model used as the data model source, call the [/v2/dataModels/{dataModelId}/sources](listdatamodelsources) endpoint and use the `versionTagId` in the response. - To retrieve the `versionTagId` for a data model, call the [/v2/dataModels](listdatamodels) endpoint and use the `versionTagId` in the response. ### Usage scenarios - **Lifecycle management**: Identify production and development resources. - [Get a data model](https://help.sigmacomputing.com/reference/getdatamodel.md): Get details of a specific data model by `dataModelId`. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](listdatamodels) endpoint. - [List data models](https://help.sigmacomputing.com/reference/listdatamodels.md): This endpoint retrieves a list of all data models available. You can use the response from this endpoint to review existing data models and determine if there are duplicates or gaps. ### Usage notes This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit. Users with the Admin account type can optionally retrieve all data models in the organization. #### Pagination This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows: - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page. - total: The total number of entries available across all pages. - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data. #### Example response for pagination { "hasMore": true, "total": 104, "nextPage": "50" } To request additional pages, include the `nextPage` option in your followup request according to the endpoint's parameter requirements. This process can be repeated until the `nextPage` option returns `null`, indicating that no further data is available. ### Usage scenarios - **Data model navigation:** Allows users to easily navigate through their available of data models and access the one they need. - **Track lineage**: Identify dependencies and lineage of data sources and data models. - [Get a dataset (Deprecated)](https://help.sigmacomputing.com/reference/getdataset.md): Get a specific dataset by datasetId **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - [List dataset sources (Deprecated)](https://help.sigmacomputing.com/reference/getdatasetsources.md): Retrieve the sources of a dataset if the source is a table or a dataset. Returns the inode IDs. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - [Grant permissions on a dataset (Deprecated)](https://help.sigmacomputing.com/reference/createdatasetgrant.md): Grant permissions to a specific dataset for users or teams. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - Grant permissions to one user or team at a time using the relevant IDs: - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Delete a permission granted on a dataset (Deprecated)](https://help.sigmacomputing.com/reference/deletedatasetgrant.md): Delete a permission granted on a specific dataset by grantId. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - Retrieve the **grantId** by calling the [/v2/datasets/{datasetId}/grants](listdatasetgrants) endpoint. - [Get grants for a dataset (Deprecated)](https://help.sigmacomputing.com/reference/listdatasetgrants.md): Get a list of permissions granted to teams and users for a specific dataset. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - [List datasets (Deprecated)](https://help.sigmacomputing.com/reference/listdatasets.md): Get a list of available datasets. Available datasets include any datasets in your My Documents folder and any datasets you have access to. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage scenarios - **Plan dataset migration**: Review the owner, location (path) of the dataset, migration status, and total number of documents that reference the dataset to plan dataset migration tasks. - **Clean up after dataset migration**: Retrieve the `dataModelId` of the data model created for the dataset. Make a GET request to the [/v2/dataModels/{dataModelId}](getdatamodel) endpoint to retrieve more details about the created data model. - **Identify unused datasets**: Review datasets that have 0 documents referencing it as a source and delete those datasets by making a DELETE request to the [/v2/files/{inodeId}](filesdelete) endpoint. - [List materializations for a dataset (Deprecated)](https://help.sigmacomputing.com/reference/listdatasetmaterializations.md): List materialization jobs for a dataset. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - [Materialize a dataset (Deprecated)](https://help.sigmacomputing.com/reference/materializedataset.md): Start a materialization run for a specific dataset. The materialization schedule for the dataset must already exist. **Deprecation notice**: [Datasets](doc:datasets) are deprecated. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](doc:migrate-a-dataset-to-a-data-model). ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](listdatasets) endpoint. - [Archive a deployment policy (Beta)](https://help.sigmacomputing.com/reference/archivedeployment.md): Archive a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - [Create a deployment policy (Beta)](https://help.sigmacomputing.com/reference/createdeployment.md): Create a deployment policy to define what documents to deploy to a tenant organization and how to swap sources for those documents. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **versionTagId** by calling the [/v2/tags](listversiontag) endpoint. - Retrieve the identifier for `sourceSwapPolicies` by calling the [/v2/sourceSwapPolicies](listsourceswappolicies) endpoint and using the `policyId` in the response. - [Get a deployment policy (Beta)](https://help.sigmacomputing.com/reference/getdeployment.md): Get details for a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - [List tenants for a deployment policy (Beta)](https://help.sigmacomputing.com/reference/listtenantsfordeployment.md): List tenants for a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. ### Usage scenarios - Review and audit documents deployed to specific tenant organizations. - [Update a deployment policy (Beta)](https://help.sigmacomputing.com/reference/updatedeployment.md): Update a deployment policy. Only the fields included in the request are changed. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - Retrieve the identifier for `sourceSwapPolicies` by calling the [/v2/sourceSwapPolicies](listsourceswappolicies) endpoint and using the `policyId` in the response. - The version tag cannot be changed after a deployment policy is created. - [Add documents to a deployment policy (Beta)](https://help.sigmacomputing.com/reference/addinodestodeployment.md): Add documents to a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - To add workbooks to a deployment policy, retrieve the relevant `workbookId` from the [/v2/workbooks](listworkbooks) endpoint. - To add data models to a deployment policy, retrieve the relevant `dataModelId` from the [/v2/datamodels](listdatamodels) endpoint. ### Usage scenarios - Centrally manage documents that are deployed to specific tenant organizations. - [List documents for a deployment policy (Beta)](https://help.sigmacomputing.com/reference/listinodesfordeployment.md): List documents for a deployment policy **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - If the user associated with the API key does not have access to the document, the `inode` field is `null`. ### Usage scenarios - Review and audit documents deployed to specific tenant organizations. - [Remove a document from a deployment policy (Beta)](https://help.sigmacomputing.com/reference/removeinodesfromdeployment.md): Remove a document from a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - To remove workbooks from a deployment policy, retrieve the relevant `workbookId` from the [/v2/workbooks](listworkbooks) endpoint. - To remove data models from a deployment policy, retrieve the relevant `dataModelId` from the [/v2/datamodels](listdatamodels) endpoint. ### Usage scenarios - Revoke access to outdated documents from tenant organizations. - [List deployment policies (Beta)](https://help.sigmacomputing.com/reference/listdeployments.md): List all deployment policies set up for an organization. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. - [Add a tenant to a deployment policy (Beta)](https://help.sigmacomputing.com/reference/addtenanttodeployment.md): Add a tenant to a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - Retrieve the `tenantId` from the [/v2/tenants](listtenants) endpoint. ### Usage scenarios - Deploy documents in a deployment policy to a specific tenant organization. - [List deployable tenant organizations (Beta)](https://help.sigmacomputing.com/reference/listdeployabletenants.md): Returns a paginated list of tenant organizations that the calling organization can deploy to. - **Parent organizations**: Returns all tenant organizations. - **Tenant organizations**: Returns tenant organizations that the calling tenant has been granted deployment capabilities to. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned an account type with the **Manage deployment policies** permission enabled. - [Remove a tenant from a deployment policy (Beta)](https://help.sigmacomputing.com/reference/removetenantfromdeployment.md): Remove a tenant from a deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](listdeployments) endpoint. - Retrieve the `tenantOrganizationId` from the [/v2/tenants](listtenants) endpoint or from the [/v2/deploymentPolicies/{deploymentPolicyId}/tenants](listtenantsfordeployment) endpoint. ### Usage scenarios - Remove documents in a deployment policy from a tenant organization. - Clean up tenant assignments when a tenant is no longer needed. - [Download an exported file](https://help.sigmacomputing.com/reference/downloadquery.md): After making a request to the [/v2/workbooks/{workbookId}/export](exportworkbook) or [/v2/reports/{reportId}/export](exportreport) endpoint, you can use this endpoint to download the exported file using the queryId returned in the response. ### Usage notes - This endpoint is rate limited to 400 requests per minute. - The export must be ready to download before you can download the results. The endpoint returns an error if the query is still processing or if the `queryId` is invalid or expired. Query results are typically available for a limited time, so make sure to download query results while they are available. - Retrieve the **queryId** by making a request to the [/v2/workbooks/{workbookId}/export](exportworkbook) or [/v2/reports/{reportId}/export](exportreport) endpoint. - Specify the file format when you make the export request. You cannot specify the file format when you download the file. ### Usage scenarios - **Scheduled reporting**: Automate the downloading of reports generated on a scheduled basis. - **Data analysis**: Retrieve large sets of data for local analysis in external tools not integrated directly with Sigma. ### Best practices - Monitor the status of the export query before attempting a download to make sure it is ready. For a code example, see [Export to CSV with Date Range Parameters](https://help.sigmacomputing.com/recipes/workbook-export-to-csv-with-date-range-parameters). - Handle errors gracefully in your application, providing users with clear messages regarding the status of their requested downloads. - [Favorite a document](https://help.sigmacomputing.com/reference/addfavorite.md): Favorite a folder or document for a specific user. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the `id` included in the response. - [Get favorite documents for a user](https://help.sigmacomputing.com/reference/listfavorites.md): Get the favorite documents for a specific user. This endpoint has the same functionality as the [List all favorite documents of a member](https://help.sigmacomputing.com/reference/listfavoriteinodes) endpoint. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - [Unfavorite a document](https://help.sigmacomputing.com/reference/removefavorite.md): Unfavorite a folder or document for a specific user. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the **id** included in the response. - [Create a file](https://help.sigmacomputing.com/reference/filescreate.md): Create an empty workspace, folder, workbook, or report in Sigma. ### Usage notes - Specify a **parentId** for a folder, workbook, or report to place it within another folder. Retrieve the ID to use as a **parentId** by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. - Specify an **ownerId** for a folder, workbook, or report to create it on behalf of another user. Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. ### Usage scenarios - **Project onboarding**: Start a new project by creating a workspace and folders to contain the workbooks for the project. - [List files](https://help.sigmacomputing.com/reference/fileslist.md): List all documents, such as workbooks and folders, accessible from the parent. ### Which files are returned by this endpoint The documents and folders accessible through this endpoint match those returned when you search in the Sigma UI. Some documents that you can view in the Sigma UI are not returned by this endpoint. - Returned documents and folders are limited to those that you have access to, such as through ownership, a document directly shared with you, a document link shared with you that you have opened, or access inherited through a folder or a workspace. This restriction also applies to users granted the Admin account type. - Newly created files are not returned immediately after creation. Updated files are reflected immediately. - If no `typeFilters` are set, only workbooks, folders, data models, datasets (deprecated), and reports are returned. To return other file types, such as a shortcut (symlink), specify a file type using the `typeFilters` option. ### Usage notes - Use the **parentId** to specify a folder and return details about the nested files and documents: - Retrieve the ID to use as a **parentId** by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. - To use the "My Documents" folder as the parent folder, call the [/v2/members/{memberId}](getmember) endpoint and use the `homeFolderId` included in the response. - If parentId is not specified, it is assumed to be the root. - Use the available filters to return files that contain a specific keyword in the name, files with specific permissions granted to the user associated with the API credentials, or files of a specific type. - [Delete a file](https://help.sigmacomputing.com/reference/filesdelete.md): Delete a folder or document, such as a workbook, data model, or report. ### Usage notes - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the `id` included in the response. - [Get file information](https://help.sigmacomputing.com/reference/filesget.md): Get information about a specific document or folder, such as a workbook, report, or data model. ### Usage notes - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the `id` included in the response. - Retrieve the **inodeId** for a data model by calling the [/v2/members/{memberId}/files/recents](listrecentinodes) endpoint and using the `id` included in the response. - [Update a file](https://help.sigmacomputing.com/reference/filesupdate.md): Update a folder or document, such as a workbook, data model, or report. ### Usage notes - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the `id` included in the response. - Specify a **parentId** to place the document within a folder. Retrieve the ID to use as a **parentId** by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. - To restore a deleted folder or document, set the **restore** parameter to `true`. - [Generate Sigma API client credentials](https://help.sigmacomputing.com/reference/generate-client-credentials.md) - [Identify unique IDs in Sigma](https://help.sigmacomputing.com/reference/identify-unique-ids-in-sigma.md) - [Get started with the Sigma REST API](https://help.sigmacomputing.com/reference/get-started-sigma-api.md) - [Use OAuth override tokens](https://help.sigmacomputing.com/reference/use-oauth-override-tokens.md) - [Create or update a grant](https://help.sigmacomputing.com/reference/creategrant.md): Create a grant or update an existing grant on a document, folder, or workspace to a user or a team by ID. ### Usage notes - This endpoint can only be used to escalate the level of access that a user has to a document. To remove or reduce a user's access to a specific document, call [/v2/grants/{grantId}](deletegrant) to delete the existing grant and re-grant the desired level of access. - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the `id` included in the response. - Retrieve the **inodeId** for a data model by calling the [/v2/dataModels](listdatamodels) endpoint and using the `dataModelId` included in the response. - Optionally specify a **tagId** to associate the permission with a specific version tag of a workbook, dataset (deprecated), or database table. Retrieve the **tagId** by calling the [/v2/tags](listversiontag) endpoint and using the `versionTagId` included in the response. - [Delete a grant](https://help.sigmacomputing.com/reference/deletegrant.md): Delete a grant by grant ID. ### Usage notes Depending on the grant object that you want to delete, you can retrieve the grantId in different ways: - For most documents, you can retrieve the **grantId** by calling the [/v2/grants](listgrants) endpoint with the **inodeId** for the document. For example, use the **workbookId** as the **inodeId**. - For a dataset (deprecated), you can also retrieve the **grantId** by calling the [/v2/datasets/{datasetId}/grants](listdatasetgrants) endpoint. - For a connection path, you can retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](listconnectionpathgrants) endpoint. ### Usage scenarios - **Principle of least privilege**: Revoke unnecessary privileges on a document by removing the grant. - [Get a grant](https://help.sigmacomputing.com/reference/getgrant.md): Return a grant object by grant ID. ### Usage notes Depending on the grant object that you want to return details about, you can retrieve the grantId in different ways: - For most documents, you can retrieve the **grantId** by calling the [/v2/grants](listgrants) endpoint with the **inodeId** for the document. For example, use the **workbookId** as the **inodeId**. - For a dataset (deprecated), you can also retrieve the **grantId** by calling the [/v2/datasets/{datasetId}/grants](listdatasetgrants) endpoint. - For a connection path, you can retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](listconnectionpathgrants) endpoint. - [List grants](https://help.sigmacomputing.com/reference/listgrants.md): List all grants for a given object. ### Usage notes You can specify one of the following: - A user by userId. Retrieve the **userId** by calling the [/v2/members](listmembers) endpoint and using the `memberId` included in the response. - A team by teamId. Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - A document (such as a workbook, report, data model, or dataset (deprecated)), folder, or workspace by inodeId. - Retrieve the **inodeId** by calling the [/v2/files](fileslist) endpoint and using the `id` included in the response. - Retrieve the **inodeId** for a data model by calling the [/v2/dataModels](listdatamodels) endpoint and using the `dataModelId` included in the response. ### Usage scenarios - **Manage inherited permissions**: Identify files and folders that have permissions directly granted to them. - **Review long-lived permissions**: Audit permissions granted more than a year ago and determine if they are still needed. - [Create a member](https://help.sigmacomputing.com/reference/createmember.md): Create a user. ### Usage notes - Creating a user with this endpoint sends an email invitation to the user. Embed users are not sent email invitations. - Review the account types returned by the [/v2/members](listmembers) endpoint to understand the format of the **memberType** string. - If **memberType** is omitted, the organization's Invitation default account type (configured in Admin > Account types) is used. If no Invitation default is configured, a built-in default account type is used. - Retrieve the **teamId**(s) by calling the [/v2/teams](listteams) endpoints. - [List member files](https://help.sigmacomputing.com/reference/listaccessibleinodes.md): List all documents and folders accessible to a specific user. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Filter to documents with specific permissions granted on them, or to specific types of documents like workbooks, workbook templates, data models, datasets (deprecated), reports, workspaces, database tables, and others. - [List all favorite documents of a member](https://help.sigmacomputing.com/reference/listfavoriteinodes.md): List the favorite documents for a specific user. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - [List recent files for a member](https://help.sigmacomputing.com/reference/listrecentinodes.md): List all recent documents and folders accessible to a specific user. By default, ignores explorations in the returned list. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - [Deactivate member](https://help.sigmacomputing.com/reference/deletemember.md): Deactivate a specific user by memberId. Users cannot be fully deleted, only deactivated. The deactivated user's documents are reassigned to the user associated with the API client credentials. For more information, see [Deactivate users](doc:deactivate-users). ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - The user is directly marked **archived** by this API. See [Deactivate users](doc:deactivate-users) for more details on deactivation. ### Usage scenarios - **User offboarding**: Manage your user base by efficiently offboarding users after they leave your organization. ### Best practices - **Confirm memberId**: Before deactivating a user, make sure the memberId is correct. - Do **not** use this for members provisioned through SCIM. - [Get member](https://help.sigmacomputing.com/reference/getmember.md): Returns a specific user by member ID. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - [List scheduled exports for a user](https://help.sigmacomputing.com/reference/listmemberschedules.md): Retrieve all scheduled exports owned by a specific user across all workbooks and reports that they have access to. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - To perform this operation for another user, you must use API credentials owned by a user assigned the Admin account type. - Non-admin users can only retrieve their own schedules. - To retrieve scheduled exports for a specific workbook, call the [/v2/workbooks/{workbookId}/schedules](listworkbookschedules) endpoint. ### Usage scenarios - **User dashboard:** Display all scheduled exports owned by a user in a centralized dashboard. - **Scheduled export management:** Allow users to view and manage all their scheduled exports across different workbooks and reports. - **Audit and compliance:** Review all scheduled exports created by a specific user for governance purposes. - **Cross-user management:** Admins can view and manage schedules on behalf of other users. - [List teams for a member](https://help.sigmacomputing.com/reference/listmemberteams.md): Retrieve a list of teams for a specific user. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - [Update member](https://help.sigmacomputing.com/reference/updatemember.md): Update a specific user by memberId. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Review the account types returned by the same endpoint to understand the format of the **memberType** string. - To deactivate a user and reassign their documents to a specific user, set `newOwnerId`to the user ID of the desired document owner, and `isArchived` to `True`. For more details, see [Deactivate a user](doc:deactivate-users). - [List members](https://help.sigmacomputing.com/reference/listmembers.md): **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request. List all users in Sigma. ### Usage notes - Filter your results using the `email` query parameter. - If using `email` to filter by email address, you must URL encode the "@" character as `%40`. - **[Deprecated]** Using the `search` parameter is deprecated. If using `search` to filter by email address, you must URL encode the "@" character as `%40`. - Using `email` and `search` together is not supported. - [List members (Paginated)](https://help.sigmacomputing.com/reference/v2_1_listmembers.md): **Attention:** This API endpoint uses pagination by default. List all users in Sigma. ### Usage notes - Filter your results using the `email` query parameter. - If using `email` to filter by email address, you must URL encode the "@" character as `%40`. - **[Deprecated]** Using the `search` parameter is deprecated. If using `search` to filter by email address, you must URL encode the "@" character as `%40`. - Using `email` and `search` together is not supported. - [Update organization settings](https://help.sigmacomputing.com/reference/updateorganizationsettings.md): Update settings for the organization associated with the API credentials. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - To update settings for a tenant organization, use [impersonation](doc:impersonate-users) to obtain a token for that tenant, then call this endpoint with that token. - [Create a report](https://help.sigmacomputing.com/reference/createreport.md): This endpoint lets you create an empty report in Sigma, enabling you to build presentation-ready documents for sharing insights with stakeholders. ### Usage notes - The **name** parameter is required to provide a name for the new report. - Use the **folderId** to specify the folder in which to save the report. Retrieve the **folderId** by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Reliable export formatting**: Users can quickly generate a new blank report to create predictable, paginated exports. ### Best practices - **Naming conventions**: Establish and follow consistent naming conventions for reports to make it easier to manage and identify them within larger projects. - **Folder organization**: Use the **folderId** to organize reports into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams. - **Access control**: Regularly review and manage access permissions for new reports, ensuring that only the appropriate personnel can view or edit sensitive data. - [List reports](https://help.sigmacomputing.com/reference/listreports.md): This endpoint retrieves a list of all available reports. Available reports include any reports in your My Documents folder and any reports you have access to. Users with the Admin account type can optionally retrieve all reports in the organization. ### Usage notes This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit. ### Pagination This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows: - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page. - total: The total number of entries available across all pages. - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data. #### Example response for pagination ```json { "hasMore": true, "total": 104, "nextPage": "50" } ``` To request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return. ### Usage scenarios - **Report navigation**: Allows users to view their collection of reports and locate ones they need. - **Integration points**: Useful for building integrations that need to present users with a list of their available reports, such as in custom applications using embeds. - [Duplicate a report](https://help.sigmacomputing.com/reference/copyreport.md): This endpoint lets you duplicate an existing report. The report copy can be placed in a different folder from the original report, potentially with a different name and description. ### Usage notes - The `reportId` parameter specifies the original report to be copied. Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - The `destinationFolderId` in the request body specifies where to place the new report. - To use the "My Documents" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](getmember) endpoint and use the `homeFolderId` included in the response. - Retrieve the **folderId** of all folders by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Reuse report structure**: Use an existing report as a baseline to make changes to. - **Backup**: Make a backup of a report before making significant changes. ### Best practices - Always verify that the destination folder has the correct permissions set to avoid access issues. - [Export data from a report](https://help.sigmacomputing.com/reference/exportreport.md): This endpoint lets you create a file containing data exported from a report. Reports are exported as entire PDF documents. Successful requests return a **queryId**. Use the **queryId** with the [/v2/query/{queryId}/download](downloadquery) endpoint to download the file when it is ready. See [Download an exported file](downloadquery). To export a report to a specific destination or recipient, see the [/v2/reports/{reportId}/send](sendreport) endpoint. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - Reports are exported as entire documents. You cannot export a specific page or element. - Only PDF exports are supported. Use the `layout` parameter to specify either `portrait` or `landscape` layout. - This endpoint is rate limited to 400 requests per minute. - For security and privacy reasons, the `queryId` used to download the exported file expires 1 hour after your request is received. You can extend this to 6 hours using the `resultsValidityTimeMs` parameter. ### Usage scenarios - **Conditional report export**: Based on an external set of conditions, export a report from Sigma. - **Integration**: Integrate enriched and analyzed data with other applications, providing the necessary data in a format that these applications can process. ### Best practices - Clearly specify parameters to retrieve only the necessary data, optimizing performance and reducing network load. - [Get a report](https://help.sigmacomputing.com/reference/getreport.md): This endpoint retrieves a report by its unique identifier (`reportId`). It provides detailed information about the report, including its name, URL, path, and other metadata. ### Usage notes - The **reportId** parameter must be a valid UUID that uniquely identifies the report. Invalid or nonexistent IDs return an error. Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. ### Usage scenarios - **Report search**: Allows users to view all of their reports and locate a specific one, as well as filter by criteria such as if it is archived. - **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific report to display its content or metadata in a custom user interface. - **Integration**: Use this endpoint for integrations where other systems need to fetch report details based on an ID provided through another interface or workflow. ### Best practices - Validate the **reportId** on the client side before making a request to avoid unnecessary server load caused by invalid requests. - [List report sources](https://help.sigmacomputing.com/reference/listreportsources.md): Get the data sources of a report given the reportId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. ### Best practices - Validate the **reportId** on the client side before making a request to avoid unnecessary server load caused by invalid requests. - [Add report schedule](https://help.sigmacomputing.com/reference/createreportschedule.md): This endpoint allows you to create a scheduled export of a report. Scheduled exports are triggered by specific conditions or timings. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - Retrieve relevant IDs based on the export contents and destination: - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Reports can only be exported as entire PDFs. Exporting a specific page or element is not supported. - If you want to impersonate a user when scheduling a report export, use the [/v2/auth/token](posttoken) endpoint. ### Usage scenarios - **Periodic reporting**: Use this endpoint to trigger routine report exports at specific intervals (such as weekly or monthly) or when specific business conditions are met (such as specific sales targets or usage thresholds). ### Best practices - Regularly review and audit schedules to ensure unnecessary or expensive schedules are not being added. - [Delete a scheduled export for a report](https://help.sigmacomputing.com/reference/deletereportschedule.md): This endpoint deletes a specific scheduled export from a report. Deleting a schedule prevents any previously configured exports or alerts from being triggered at the scheduled times. ### Usage notes - The `reportId` in the path is required to identify the report. Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - The `scheduleId` in the path is required to specify which schedule to delete. Retrieve the **scheduleId** by calling the [/v2/reports/{reportId}/schedules](listreportschedules) endpoint and using the `scheduledNotificationId` in the response. ### Usage scenarios - **Audit operations**: Use this endpoint to remove unnecessary or outdated schedules that are no longer relevant to the report's current use case. ### Best practices - Make sure that deleting a given schedule is in compliance with your organization's data governance and operational policies. - Verify the `scheduleId` and `reportId` before making a deletion request to prevent errors. - [List scheduled report exports](https://help.sigmacomputing.com/reference/listreportschedules.md): This endpoint retrieves a list of all scheduled exports for a specified report. These schedules represent planned events that can trigger exports based on various conditions and timings. ### Usage Notes - The **reportId** in the path parameter identifies the report whose scheduled exports are to be listed. Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - Use pagination query parameters to manage the volume of data returned by this endpoint. ### Usage Scenarios - **Schedule overview**: Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a report. - **Audit and compliance**: This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies. ### Best Practices - Implement client-side handling to manage paginated data effectively, especially in cases where a report has a large number of scheduled exports. - Regularly audit schedules to keep them up-to-date and aligned with current workflows. - [Update a report schedule](https://help.sigmacomputing.com/reference/updatereportschedule.md): This endpoint allows you to update an existing scheduled report export. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - Retrieve the **scheduleId** by calling the [/v2/reports/{reportId}/schedules](listreportschedules) endpoint. - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. ### Usage scenarios - **Audit schedules**: Update schedules to ensure they are being exported at the correct times or to the correct recipients. - [Export a report](https://help.sigmacomputing.com/reference/sendreport.md): Export a report to one or more specified destinations or recipients. Supported destinations include Slack channels, Google Drive, cloud storage, and webhooks. Supported recipients include an organization member, team, or email address. If you want to download a report PDF instead, see the [/v2/reports/{reportId}/export](exportreport) endpoint. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](listreports) endpoint. - Only PDF exports are supported for reports. - This endpoint is rate limited to 100 requests per minute. - [Create a SAML service provider certificate (Beta)](https://help.sigmacomputing.com/reference/createsamlserviceprovidercertificate.md): Create a certificate for a given SAML service provider. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](listsamlserviceproviders) endpoint. - [List SAML service providers (Beta)](https://help.sigmacomputing.com/reference/listsamlserviceproviders.md): List all SAML service providers in the organization. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - [Activate a SAML service provider certificate (Beta)](https://help.sigmacomputing.com/reference/activatesamlserviceprovidercertificate.md): Activate a certificate. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Activating a certificate deactivates all certificates used for the same purpose by the same SAML service provider. For example, activating a signing certificate deactivates all other signing certificates in use by the same SAML SP. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](listsamlserviceproviders) endpoint. - Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](listsamlspcertificates) endpoint. - [Deactivate a SAML service provider certificate (Beta)](https://help.sigmacomputing.com/reference/deactivatesamlserviceprovidercertificate.md): Deactivate a certificate. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](listsamlserviceproviders) endpoint. - Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](listsamlspcertificates) endpoint. - [Get a SAML service provider certificate (Beta)](https://help.sigmacomputing.com/reference/getsamlserviceprovidercertificate.md): Get a certificate to use with your IdP when configuring Sigma as a service provider. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](listsamlserviceproviders) endpoint. - Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](listsamlspcertificates) endpoint. - Signing certificates are used by your IdP to verify signatures that Sigma attaches to SAML requests. - Encryption certificates are used by your IdP to encrypt SAML responses sent to Sigma. - [List SAML service provider certificates (Beta)](https://help.sigmacomputing.com/reference/listsamlserviceprovidercertificates.md): List all certificates for a given SAML service provider. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](listsamlserviceproviders) endpoint. - [Remove a SAML service provider certificate (Beta)](https://help.sigmacomputing.com/reference/removesamlserviceprovidercertificate.md): Remove a certificate. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](listsamlserviceproviders) endpoint. - Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](listsamlspcertificates) endpoint. - [Accept a pending template share](https://help.sigmacomputing.com/reference/accepttemplateshare.md): If a workbook template has been shared with your organization but not yet accepted, accept the template share. ### Usage notes - Retrieve pending template shares by calling the [/v2/shared_templates/shared_with_you](listtemplatessharedwithyou) endpoint and specifying `pending` as `true`. - Retrieve the **shareId** by calling the [/v2/shared_templates/shared_with_you](listtemplatessharedwithyou) endpoint and using the `shareId` included in the response. - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - Retrieve the **inodeId** for a table by calling the [/v2/connections/{connectionId}/lookup](lookupconnection) endpoint. - The key of the **sourceSwaps** object is the original id of the table, dataset, or connection in the organization that shared the template - [Delete a template share](https://help.sigmacomputing.com/reference/deleteexternalshare.md): Remove a template shared with your organization. **Usage notes** - Retrieve the **shareId** by calling the [/v2/shared_templates/shared_with_you](listtemplatessharedwithyou) endpoint and using the `shareId` included in the response. - [List templates shared with your organization](https://help.sigmacomputing.com/reference/listtemplatessharedwithyou.md): Lists all workbook templates shared with your organization. ### Usage notes - Use the `pending` parameter to identify templates that have been shared but not yet accepted. - [Share a workbook with another organization](https://help.sigmacomputing.com/reference/shareworkbookcrossorg.md): Share a workbook or a template with another organization. Optionally share the associated datasets, if datasets (deprecated) are used as the source. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **templateId** by calling the [v2/templates](listtemplates) endpoint. - Retrieve the organization slug from the URL. Ask the recipient organization for the segment of their Sigma URL following `app.sigmacomputing.com`. For example, `app.sigmacomputing.com/sigma-docs` has an organization slug of `sigma-docs`. - [Create a tenant organization (Beta)](https://help.sigmacomputing.com/reference/createtenant.md): Create a new tenant organization with the specified name and organization slug to be used in the URL. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - The **tenantOrganizationName** is displayed as the organization name in the Sigma interface. - The **tenantOrganizationSlug** must be unique and is used in URLs to identify the tenant organization. - [Add deployment capabilities to a tenant (Beta)](https://help.sigmacomputing.com/reference/addtenantdeploymentcapabilities.md): Grant a tenant organization the capability to deploy to other tenant organizations. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve **tenantOrganizationId** values by calling the [/v2/tenants](listtenants) endpoint. - [List tenant deployment capabilities (Beta)](https://help.sigmacomputing.com/reference/listtenantdeploymentcapabilities.md): Retrieve a paginated list of tenant organizations that the specified tenant organization can deploy to. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listtenants) endpoint. - Use **pageToken** and **pageSize** to paginate results. - [Remove deployment capabilities from a tenant (Beta)](https://help.sigmacomputing.com/reference/removetenantdeploymentcapabilities.md): Revoke a tenant organization's capability to deploy to one or more tenant organizations. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve **tenantOrganizationId** values by calling the [/v2/tenants](listtenants) endpoint. - Existing deployments from this tenant organization to the specified tenant organizations will be removed. - [List tenant organizations (Beta)](https://help.sigmacomputing.com/reference/listtenants.md): Retrieve a paginated list of tenant organizations with optional filtering and sorting. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Use **pageToken** and **pageSize** parameters to manage paginated responses. - Use **search** to filter results by organization slug or ID of the user who created the tenant. - Use **key** and **order** to sort results by creation date, ID of the user who created the tenant, name, or URL. - [Delete a tenant organization (Beta)](https://help.sigmacomputing.com/reference/deletetenant.md): Delete a tenant organization by tenantOrganizationId. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listtenants) endpoint. - This action permanently removes the tenant organization and cannot be undone. - [Get details for a tenant organization (Beta)](https://help.sigmacomputing.com/reference/gettenant.md): Retrieve details of a specific tenant organization by tenantOrganizationId. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listtenants) endpoint. - [Get deployed workbook in tenant organization (Beta)](https://help.sigmacomputing.com/reference/gettenantworkbook.md): Retrieve the workbook ID for a workbook deployed to a tenant organization for a given parent workbook and deployment policy. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - The parent workbook must be part of the specified deployment policy. - The workbook must be deployed to the specified tenant organization. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listtenants) endpoint. - Retrieve the **deploymentPolicyId** by calling the [/v2/deploymentPolicies](listdeployments) endpoint. - Retrieve the **parentWorkbookId** by calling the [/v2/deploymentPolicies/{deploymentPolicyId}/files](listinodesfordeployment) endpoint and using the `workbookId` included in the response. - For version-tagged deployment policies, you may pass either the source workbook ID or the version-tagged workbook ID as the **parentWorkbookId**. - [Update details of a tenant organization (Beta)](https://help.sigmacomputing.com/reference/patchtenant.md): Update the details of an existing tenant organization. The organization name and slug can be updated through this endpoint. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listtenants) endpoint. - [Create a source swap policy (Beta)](https://help.sigmacomputing.com/reference/createsourceswappolicy.md): Create a source swap policy. **Beta**: Creating a **Connection** source swap policy is in private beta and must be enabled for your organization. Creating a **Deployment** source swap policy is in public beta. This documentation is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **connectionId** to use as the **fromConnectionId** by calling the [/v2/connections](listconnections) endpoint. - Retrieve the **userAttributeId** to use in the **swaps** object by calling the [/v2/user-attributes](listuserattributes) endpoint. - [List source swap policies (Beta)](https://help.sigmacomputing.com/reference/listsourceswappolicies.md): Get a list of source swap policies. **Beta**: Getting a list of **Connection** source swap policies is in private beta and must be enabled for your organization. Getting a list of **Deployment** source swap policies is in public beta. This documentation is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. - [Delete a source swap policy (Beta)](https://help.sigmacomputing.com/reference/deletesourceswappolicy.md): Delete a source swap policy by policy ID. **Beta**: Deleting a **Connection** source swap policy is in private beta and must be enabled for your organization. Deleting a **Deployment** source swap policy is in public beta. This documentation is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](listsourceswappolicies) endpoint. - [Get a source swap policy (Beta)](https://help.sigmacomputing.com/reference/getsourceswappolicy.md): Get a source swap policy by policy ID. **Beta**: Getting details for a **Connection** source swap policy is in private beta and must be enabled for your organization. Getting details for a **Deployment** source swap policy is in public beta. This documentation is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](listsourceswappolicies) endpoint. - [Update a source swap policy (Beta)](https://help.sigmacomputing.com/reference/updatesourceswappolicy.md): Update a source swap policy. **Beta**: Updating a **Connection** source swap policy is in private beta and must be enabled for your organization. Updating a **Deployment** source swap policy is in public beta. This documentation is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](listsourceswappolicies) endpoint. - Retrieve the **connectionId** to use as the **fromConnectionId** by calling the [/v2/connections](listconnections) endpoint. - Retrieve the **userAttributeId** to use in the **swaps** object by calling the [/v2/user-attributes](listuserattributes) endpoint. - [Create a tag](https://help.sigmacomputing.com/reference/createversiontag.md): Create a version tag to use, for example, for workbooks. - [Get tags](https://help.sigmacomputing.com/reference/listversiontag.md): Get a list of version tags. - [Delete a tag](https://help.sigmacomputing.com/reference/deleteversiontag.md): Delete a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](listversiontag) endpoint and using the `versionTagId` in the response. - [List workbooks for a tag](https://help.sigmacomputing.com/reference/listworkbooksfortag.md): Get a list of workbooks for a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](listversiontag) endpoint and using the `versionTagId` in the response. - [Update a tag](https://help.sigmacomputing.com/reference/updateversiontag.md): Update the description of a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](listversiontag) endpoint and using the `versionTagId` in the response. - [Create a team](https://help.sigmacomputing.com/reference/createteam.md): Create a Sigma team. ### Usage notes - Specify members to add to the team by userId or memberId. - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - [Assign user attributes to a team](https://help.sigmacomputing.com/reference/assignuserattributestoteam.md): Assign one or more user attributes to a specific team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Retrieve a list of available user attributes by calling the [/v2/user-attributes](listuserattributes) endpoint. - Maximum 100 assignments per request. - [Delete a team](https://help.sigmacomputing.com/reference/deleteteam.md): Delete a specific team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Get a team](https://help.sigmacomputing.com/reference/getteam.md): Returns details about a team based on team ID. The response includes an array of member IDs that identify the users in the team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Get team user attributes](https://help.sigmacomputing.com/reference/getteamuserattributeassignments.md): Get a list of user attributes assigned to a team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [List team members](https://help.sigmacomputing.com/reference/getteammembers.md): Get a paginated list of team members in a specific team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Returns the members of the team by `userId`. ### Usage scenarios - Identify the admin of a team. - [Update team members](https://help.sigmacomputing.com/reference/updateteammembers.md): Update the members of a specific team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Inactive members cannot be added or removed from a team. - [Update a team](https://help.sigmacomputing.com/reference/updateteam.md): Update the name, description, and visibility of a team. ### Usage notes - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [List teams](https://help.sigmacomputing.com/reference/listteams.md): **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request. List all teams in Sigma. - [List teams (Paginated)](https://help.sigmacomputing.com/reference/v2_1_listteams.md): **Attention:** This API endpoint uses pagination by default. List all teams in Sigma. - [Get template](https://help.sigmacomputing.com/reference/gettemplate.md): Get a template by template ID. ### Usage notes - Retrieve the **templateId** by calling the [/v2/templates](listtemplates) endpoint. - [List templates](https://help.sigmacomputing.com/reference/listtemplates.md): Returns a list of available templates. ### Usage notes - Official Sigma templates are created by SigmaSchedulerRobot. - [Create workbook from template](https://help.sigmacomputing.com/reference/saveworkbookfromtemplate.md): Create a workbook by saving it from a template. ### Usage notes - Retrieve the **templateId** by calling the [/v2/templates](listtemplates) endpoint. - Retrieve the **folderId** by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. To use the "My Documents" folder as the destination folder, call the [/v2/members/{memberId}](getmember) endpoint and use the `homeFolderId` included in the response. - If you leave the name or description options blank, the workbook created inherits the values of the template. - [Swap template data sources](https://help.sigmacomputing.com/reference/sourceswaptemplate.md): Swap the data sources used by a workbook template. You can swap from one connection to another, and/or from one dataset to another. ### Usage notes - Retrieve the **templateId** by calling the [/v2/templates](listtemplates) endpoint. - Retrieve the **connectionId** to use as the **toId** by calling the [/v2/connections](listconnections) endpoint. - To map the sources of a specific element, you can use the table or dataset ID: - Retrieve the **fromId** for a specific data element by calling the [/v2/workbooks/{workbookId}/lineage/elements/{elementId}](listlineage) endpoint and using the `source` key from the response, which looks like `inode-2PBoXx3UabchxF1F3l07kE`. The ID is everything after `inode-`. - Retrieve table and dataset IDs by calling the [/v2/files](fileslist) endpoint. Use the `typeFilters` option to filter for table and dataset files. Use `id` field in the response as the `fromId` or `toId`, as relevant. - [Create organization translation file](https://help.sigmacomputing.com/reference/createorgtranslation.md): This endpoint creates a new organization translation file for the specified locale, containing the translation key-value pairs, if provided. You can also use this endpoint to create custom translations for a locale. Entering common phrases and their translations used in workbooks across your organization ensures consistent translations for all users. ### Usage Notes - Retrieve the supported locale identifiers to use for **lng** from [Supported languages and locales](doc:manage-workbook-localization#supported-languages-and-locales). - [List organization translation files](https://help.sigmacomputing.com/reference/listorglocales.md): This paginated endpoint lists all the translation files that have been defined at the organization level. ### Usage notes This endpoint requires no parameters for basic requests but supports query parameters for pagination and response limit. #### Pagination This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows: - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page. - total: The total number of entries available across all pages. - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data. #### Example response for pagination { "hasMore": true, "total": 104, "nextPage": "50" } To request additional pages, include the `nextPage` option in your followup request according to the endpoint's parameter requirements. This process can be repeated until `nextPage` is `null`. - [Delete organization translation file with variant](https://help.sigmacomputing.com/reference/deleteorgtranslationwithvariant.md): This endpoint deletes the translation file for the specified custom translation (**lng_variant**) for a locale (**lng**). ### Usage notes - Retrieve the **lng** and **lng_variant** by calling the [/v2/translations/organization](listorglocales) endpoint. - [Get organization translation file with variant](https://help.sigmacomputing.com/reference/getorgtranslationswithvariant.md): This endpoint returns a JSON file containing the translations and custom translations (**lng_variant**) for a locale (**lng**). ### Usage notes - Retrieve the **lng** and **lng_variant** by calling the [/v2/translations/organization](listorglocales) endpoint. - [Update organization translation file with variant](https://help.sigmacomputing.com/reference/updateorgtranslationwithvariant.md): This endpoint updates the translation file for the specified custom translation (**lng_variant**) for a locale (**lng**). ### Usage notes - Retrieve the **lng** and **lng_variant** by calling the [/v2/translations/organization](listorglocales) endpoint. - [Delete organization translation file](https://help.sigmacomputing.com/reference/deleteorgtranslation.md): This endpoint deletes the translation file for the specified locale (**lng**) without any custom translations. ### Usage notes - Retrieve the **lng** by calling the [/v2/translations/organization](listorglocales) endpoint. - [Get organization translation file](https://help.sigmacomputing.com/reference/getorgtranslations.md): This endpoint returns a JSON file containing the translations for a specified locale (**lng**) without custom translations. ### Usage notes - Retrieve the **lng** by calling the [/v2/translations/organization](listorglocales) endpoint. - [Update organization translation file](https://help.sigmacomputing.com/reference/updateorgtranslation.md): This endpoint updates the translation file for a specified locale (**lng**) without custom translations. ### Usage notes - Retrieve the **lng** by calling the [/v2/translations/organization](listorglocales) endpoint. - [Create a user attribute](https://help.sigmacomputing.com/reference/createuserattribute.md): Create a new user attribute. An optional description and default value can be provided. - [List user attributes](https://help.sigmacomputing.com/reference/listuserattributes.md): Get a list of available user attributes, values, and owners. - [Delete a user attribute for a team](https://help.sigmacomputing.com/reference/deleteuserattributeforteam.md): Delete a specific user attribute for a specific team. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Get teams for a user attribute](https://help.sigmacomputing.com/reference/getuserattributeteamassignments.md): Get a list of teams that have a specific user attribute defined, and the assigned value for the user attribute. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - [Set a user attribute for teams](https://help.sigmacomputing.com/reference/setuserattributeforteams.md): Assign and set the value of a specific user attribute for one or more teams. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Update a user attribute for teams](https://help.sigmacomputing.com/reference/updateuserattributeforteams.md): Update a user attribute for one or more teams. Currently, this endpoint only supports deleting a user attribute assignment. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Delete a user attribute for a tenant (Beta)](https://help.sigmacomputing.com/reference/deleteuserattributefortenant.md): Delete a specific user attribute for a specific tenant. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](lisuserattributes) endpoint. - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listenants) endpoint and using the `tenantOrganizationId` included in the response. - [Get tenants for a user attribute](https://help.sigmacomputing.com/reference/getuserattributetenantassignments.md): Get a list of tenants that have a specific user attribute defined, and the assigned value for the user attribute. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - [Set a user attribute for tenants (Beta)](https://help.sigmacomputing.com/reference/setuserattributefortenants.md): Assign and set the value of a specific user attribute for one or more tenants. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Specify one or more tenant by tenantOrganizationId. Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listTenants) endpoint and using the `tenantOrganizationId` included in the response. - [Update a user attribute for tenants (Beta)](https://help.sigmacomputing.com/reference/updateuserattributefortenants.md): Update a user attribute for one or more tenants. Currently, this endpoint only supports deleting a user attribute assignment. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](doc:sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Specify one or more tenants by tenantOrganizationId. Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](listtenants) endpoint and using the `tenantOrganizationId` included in the response. - [Delete a user attribute](https://help.sigmacomputing.com/reference/deleteuserattribute.md): Delete a user attribute. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - This action permanently removes the user attribute from the organization and cannot be undone. - [Get a user attribute](https://help.sigmacomputing.com/reference/getuserattribute.md): Get details for a specific user attribute. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - [Delete a user attribute for a user](https://help.sigmacomputing.com/reference/deleteuserattributeforuser.md): Delete a specific user attribute for a specific user. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Retrieve the **userId** by calling the [/v2/members](listmembers) endpoint and using the `memberId` included in the response. - [Get users for a user attribute](https://help.sigmacomputing.com/reference/getuserattributeuserassignments.md): Get a list of users that have a specific user attribute defined, and the assigned value for the user attribute. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - [Set a user attribute for users](https://help.sigmacomputing.com/reference/setuserattributeforusers.md): Assign and set the value of a specific user attribute for one or more users. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Specify one or more users by userId. Retrieve the **userId** by calling the [/v2/members](listmembers) endpoint and using the `memberId` included in the response. - [Update a user attribute for users](https://help.sigmacomputing.com/reference/updateuserattributeforusers.md): Update a user attribute for one or more users. Currently, this endpoint only supports deleting a user attribute assignment. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](listuserattributes) endpoint. - Specify one or more users by userId. Retrieve the **userId** by calling the [/v2/members](listmembers) endpoint and using the `memberId` included in the response. - [Get current user](https://help.sigmacomputing.com/reference/whoami.md): Get the identity and authentication status of the current user. ### Usage notes Call this endpoint after authenticating to retrieve user details. It does not require any parameters other than the user's valid session or authentication token included in the request headers. ### Usage scenarios - **Session validation:** Quickly confirm user authentication and retrieve session-specific details at the start of a new session. - **User configuration:** Retrieve settings or configurations specific to the user, allowing for a customized application experience based on user roles and permissions. ### Best practices - Call this endpoint at the beginning of each session to ensure that the user's credentials are still valid and have not been revoked. - Use the information provided by this endpoint to tailor the user interface and functionality accessible to the user, enhancing security and user experience. - [Add a bookmark to a tagged workbook](https://help.sigmacomputing.com/reference/createtaggedworkbookbookmark.md): Add a bookmark to a version tagged workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **tagName** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - Retrieve the **workbookVersion** by calling the [/v2/workbooks](listworkbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version. - Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`. - [Delete a bookmark from a tagged workbook](https://help.sigmacomputing.com/reference/deletetaggedworkbookbookmark.md): Delete a bookmark from a version tagged workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **tagName** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](listbookmarks) endpoint. - [Delete a bookmark from a workbook](https://help.sigmacomputing.com/reference/deleteworkbookbookmarks.md): Delete a bookmark from a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](listbookmarks) endpoint. - [Get a bookmark in a tagged workbook](https://help.sigmacomputing.com/reference/gettaggedworkbookbookmark.md): Retrieve details for a bookmark in a tagged workbook based on bookmarkId ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **tagName** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](listbookmarks) endpoint. - [List bookmarks in a tagged workbook](https://help.sigmacomputing.com/reference/gettaggedworkbookbookmarks.md): Returns a list of bookmarks in a tagged workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **tagName** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - [Get a bookmark](https://help.sigmacomputing.com/reference/getworkbookbookmark.md): Retrieve details of a workbook bookmark. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](getworkbookbookmarks) endpoint. - [List bookmarks in a workbook](https://help.sigmacomputing.com/reference/getworkbookbookmarks.md): Returns a list of available bookmarks in a workbook. Available bookmarks are those that you have created or that have been shared with you. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Maintenance and governance**: Review workbook bookmarks for usage, validity, and freshness. - [Add a bookmark to a workbook](https://help.sigmacomputing.com/reference/postworkbookbookmarks.md): Add a bookmark to a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **workbookVersion** by calling the [/v2/workbooks](listworkbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version. - Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`. - [Update a bookmark in a tagged workbook](https://help.sigmacomputing.com/reference/updatetaggedworkbookbookmark.md): Update a bookmark in a version tagged workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **tagName** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](listbookmarks) endpoint. - Retrieve the **workbookVersion** by calling the [/v2/workbooks](listworkbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version. - Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`. - [Update a workbook bookmark](https://help.sigmacomputing.com/reference/updateworkbookbookmark.md): Update a workbook bookmark, for example by updating the bookmark to use a new exploration of the workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](listbookmarks) endpoint. - Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`. - [Create a workbook](https://help.sigmacomputing.com/reference/createworkbook.md): This endpoint lets you create an empty workbook in Sigma, letting you start a data analysis project or report without any pre-existing templates or data sources set up. ### Usage notes - The `name` parameter is required to provide a name for the new workbook. - Use the **folderId** to specify the folder in which to save the workbook. Retrieve the **folderId** by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Project initialization**: When starting a new project that requires data analysis or reporting, users can quickly generate a new blank workbook to begin structuring their data and analyses. - **Template preparation**: Administrators or team leads might create blank workbooks to set up standardized templates that their teams can use to maintain consistency in data handling and reporting. ### Best practices - **Naming conventions**: Establish and follow consistent naming conventions for workbooks to make it easier to manage and identify them within larger projects. - **Folder organization**: Use the **folderId** to organize workbooks into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams. - **Access control**: Regularly review and manage access permissions for new workbooks, ensuring that only the appropriate personnel can view or edit sensitive data. - [List columns for a workbook element](https://help.sigmacomputing.com/reference/getelementcolumns.md): This endpoint retrieves a list of columns associated with a specific element within a workbook. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](listworkbookpageelements) endpoint. ### Usage scenarios - **Data exploration:** Helps users to explore the data structure of a workbook element, facilitating deeper analysis and understanding. - **Integration tasks:** Useful for developers integrating Sigma with other tools, needing to know the data structure to map data accurately. ### Best practices - Validate the elementId to make sure it corresponds to the correct workbook element before querying. - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure. - [Get the SQL query for a workbook element](https://help.sigmacomputing.com/reference/getelementquery.md): This endpoint retrieves the SQL query associated with a specific element in a workbook. It allows users to view and understand how the data for that element is being processed and transformed, which is critical for debugging, optimization, and educational purposes. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **elementId** for a custom SQL element by calling the [/v2/workbooks/{workbookId}/queries](listworkbookqueries) endpoint. ### Usage scenarios - **Development and debugging:** Provides developers and analysts with the ability to retrieve and review the SQL code behind workbook elements, facilitating troubleshooting and enhancements. - **Educational insight:** Useful for training purposes or for users learning to understand the impact of various transformations and filters applied within their Sigma workbooks. ### Best practices - Ensure proper access controls are in place to manage who can view potentially sensitive query information. - Use this endpoint as part of a regular review process to ensure that all queries are optimized and up to date with current data schemas. - [List lineage of a workbook element](https://help.sigmacomputing.com/reference/listlineage.md): This endpoint retrieves the lineage and dependencies of a specific workbook element. It provides a detailed view of how data is interconnected within a workbook, which can be critical for understanding data sources and dependencies. ### Usage notes - **workbookId:** The UUID of the workbook containing the element. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - **elementId:** The UUID of the element within the workbook whose lineage is being queried. Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](listworkbookpageelements) endpoint. - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error. ### Usage scenarios - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements. - **Debugging and optimization:** Helps in identifying and resolving issues in data processing or in the structure of workbook setups. - **Data source management**: Identify the data sources in use in a specific workbook. ### Best practices - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized. - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams. - [Create an embed for a workbook](https://help.sigmacomputing.com/reference/createworkbookembed.md): This endpoint lets you create an embed for a specific workbook. You can embed an entire workbook, a specific page, or an individual element within a workbook. Embedding enables seamless integration of Sigma content into other applications, websites, or internal platforms, providing a flexible and dynamic way to present and interact with data. ### Embedding options - Publicly embed Sigma in a public website by creating an embed of type `public`. - Securely embed Sigma in an authenticated host application. - (Recommended) Use JSON Web Tokens (JWT) to sign the workbook URL outputted by the [/v2/workbooks](listworkbooks) endpoint instead of the output of this endpoint. See [Create a secure embed](doc:create-a-secure-embed). - (Deprecated) Use this endpoint to create an embed of type `secure`. This option is deprecated. See [Migrate to JWT-signed secure embed URLs](doc:migrate-to-jwt-signed-secure-embed-urls). ### Usage notes - The endpoint requires the workbookId as a path parameter. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - The body of the request must specify the type of embed (public). - You must specify the source type (workbook, page, element) and ID for that source to create the embed. - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint. - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](listworkbookpageelements) endpoint. ### Usage scenarios - **Web application integration:** Developers can use this API to generate the embed URL for integration into their application or for display on a public-facing webpage. ### Best practices - Validate the `workbookId` and `sourceId` to ensure they refer to existing resources before attempting to create an embed. - Consider the security settings of the embed type to match the integration context, ensuring that data exposure is controlled and appropriate for the audience. - [Delete an embed from a workbook](https://help.sigmacomputing.com/reference/deleteworkbookembeds.md): This endpoint lets you delete an embed associated with a specific workbook. It is useful for cleaning up unnecessary or outdated embeds to maintain a streamlined environment. ### Usage Notes - Requires `workbookId` and `embedId` as path parameters to specify which embed to delete. - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **embedId** by calling the [/v2/workbooks/{workbookId}/embeds](listworkbookembeds) endpoint. ### Usage Scenarios - **Maintenance**: Regularly remove unused or expired embeds to keep your Sigma environment clean and efficient. ### Best Practices - Confirm the usage and necessity of an embed before deletion to avoid disrupting dependent services or applications. - [Get embeds for a workbook](https://help.sigmacomputing.com/reference/listworkbookembeds.md): This endpoint retrieves the list of available embeds for a specific workbook. The response provides the embedUrl and indicates whether an embed is public. ### Usage notes - The endpoint requires the `workbookId` as a path parameter to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Integration with third-party applications:** Developers can use this endpoint to list embeds that integrate workbook content into third-party applications, enhancing functionality or providing customized views. - **Internal dashboards:** Teams within an organization can embed workbook content into internal dashboards to monitor real-time data and analytics from various workbooks without directly accessing Sigma. ### Best practices - Ensure that the embeds are used in compliance with data governance and privacy policies. - Regularly review and manage the access permissions for each embed to prevent unauthorized data exposure. - [Delete a scheduled export for a workbook](https://help.sigmacomputing.com/reference/deleteworkbookschedule.md): This endpoint deletes a specific scheduled export from a workbook. Deleting a schedule prevents any previously configured exports or alerts from being triggered at the scheduled times. ### Usage notes - The `workbookId` in the path is required to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - The `scheduleId` in the path is required to specify which schedule to delete. Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](listworkbookschedules) endpoint and using the `scheduledNotificationId` in the response. ### Usage scenarios - **Cleanup operations:** Use this endpoint to remove unnecessary or outdated schedules that are no longer relevant to the workbook's current use case. - **Configuration updates:** When a workbook's usage patterns change, corresponding schedules might need to be deleted to align with the new setup. ### Best practices - Make sure that deleting a given schedule is in compliance with your organization's data governance and operational policies. - Verify the `scheduleId` and `workbookId` before making a deletion request to prevent errors. - [List scheduled workbook exports](https://help.sigmacomputing.com/reference/listworkbookschedules.md): **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request. This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings. ### Usage Notes - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Use pagination query parameters to manage the volume of data returned by this endpoint. ### Usage Scenarios - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook. - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies. ### Best Practices - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports. - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows. - [List scheduled workbook exports (Paginated)](https://help.sigmacomputing.com/reference/v2_1_listworkbookschedules.md): **Attention:** This API endpoint uses pagination by default. This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings. ### Usage Notes - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Use pagination query parameters to manage the volume of data returned by this endpoint. ### Usage Scenarios - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook. - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies. ### Best Practices - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports. - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows. - [Add workbook schedule](https://help.sigmacomputing.com/reference/postworkbookschedule.md): Add a schedule to a workbook to export data from the workbook on a periodic basis. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve relevant IDs based on the export contents and destination: - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint. - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](listworkbookpageelements) endpoint. - [Update a workbook schedule](https://help.sigmacomputing.com/reference/updateworkbookschedule.md): Update a schedule of a workbook to export data from the workbook on a periodic basis. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](listworkbookschedules) endpoint. - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - [Export data from a workbook](https://help.sigmacomputing.com/reference/exportworkbook.md): This endpoint lets you create a file containing data exported from a workbook, allowing you to retrieve large sets of data in a structured format. Export the entire workbook, a single workbook page, or an individual element. You can specify parameters to filter the data and format options for the file. Different file formats, including CSV, PDF, JSON, and others, are supported for different export choices. See [Send or schedule workbook exports](doc:send-or-schedule-workbook-exports) for details on supported formats for different types of exports. Successful requests to the endpoint return a queryId. Use the **queryId** with the [/v2/query/{queryId}/download](downloadquery) endpoint to download the requested file when it is ready. See [Download an exported file](downloadquery). ## Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - This endpoint is rate limited to 400 requests per minute. - This endpoint exports up to 1 million rows for CSV/XLSX/JSON file formats. You can export more rows if you batch your requests in chunks of up to 1 million rows. Use the `rowLimit` parameter to specify the size of the chunk and the `offset` parameter to specify the row to start the next chunk from. For example, if you specify a rowLimit of 2500, to export the next chunk of 2500 rows, specify an offset of 2501. The order of the data matches the order in the data element when the request is made, so there is a possibility of data overlap between requests. - For security and privacy reasons, the `queryId` used to download the exported data expires 1 hour after your request is received and the file becomes available to download. You can extend this default expiration to 6 hours using the `resultsValidityTimeMs` request parameter. - When exporting a PNG file, the `pixelWidth` and `pixelHeight` parameters are respected on a best effort basis and the output might not match the requested dimensions. ## Usage scenarios - Conditional workbook export: Based on an external set of conditions, export a workbook from Sigma. - Data analysis: Export specific sets of data for offline analysis, leveraging tools that might not connect directly to a data warehouse. - Integration: Integrate enriched and analyzed data with other applications, providing the necessary data in a format that these applications can process. ## Best practices - Clearly specify parameters to retrieve only the necessary data, optimizing performance and reducing network load. - [Export a workbook](https://help.sigmacomputing.com/reference/sendworkbook.md): Export a workbook to one or more destinations, such as an email address, a Slack channel, or cloud storage. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - This endpoint is rate limited to 100 requests per minute. - [Grant permissions on a workbook to users or teams](https://help.sigmacomputing.com/reference/createworkbookgrant.md): You can use this endpoint to grant specific document permissions on a specific workbook to users or teams. ### Usage notes - Ensure the **workbookId** in the path is valid and that the user has rights to modify its permissions. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant. - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. - Grant permissions on a specific version tag of a workbook by specifying the **tagId**. Retrieve the **tagId** by calling the [/v2/tags](listversiontag) endpoint and using the `versionTagId` in the response. ### Usage scenarios - **Team collaboration**: Granting edit permissions to a team for collaborative work on a project. - **External consultant**: Providing view access to an external consultant. ### Best practices - Validate user and team IDs before submitting them in a request to avoid errors. - Use the **tagId** to help manage and revoke grants systematically as project requirements change. - [Delete a workbook grant](https://help.sigmacomputing.com/reference/deleteworkbookgrant.md): This endpoint deletes a specific grant from a workbook. Deleting a grant revokes the permissions associated with it, ensuring that the specified users or teams no longer have the access rights previously granted. ### Usage notes - **workbookId:** The identifier of the workbook from which the grant is to be deleted. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - **grantId:** The identifier of the grant that needs to be removed. Retrieve the **grantId** by calling the [/v2/grants](listgrants) endpoint with the `workbookId` as the `inodeId`. ### Usage scenarios - **Access revocation:** Administrators can use this endpoint to manage and revoke access as team roles or project needs evolve. - **Security compliance:** Ensures that access to sensitive data within workbooks is tightly controlled and can be promptly adjusted in response to security policy changes or personnel updates. ### Best practices - Always confirm the identities associated with both the workbook and grant before proceeding with deletion to avoid accidental revocations. - Log and audit all grant deletions to maintain records for security audits and compliance tracking. - [List workbooks](https://help.sigmacomputing.com/reference/listworkbooks.md): This endpoint retrieves a list of all available workbooks. Available workbooks include any workbooks in your My Documents folder and any workbooks you have access to. Users with the Admin account type can optionally retrieve all workbooks in the organization. ### Usage notes This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit. #### Pagination This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows: - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page. - total: The total number of entries available across all pages. - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data. #### Example response for pagination ```json { "hasMore": true, "total": 104, "nextPage": "50" } ``` To request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return. ### Usage scenarios - **Workbook navigation:** Allows users to easily navigate through their collection of workbooks and access the one they need. - **Integration points:** Useful for building integrations that need to present users with a list of their available workbooks, such as in custom applications using Sigma Embeds. - [Get a materialization job](https://help.sigmacomputing.com/reference/getworkbookmaterialization.md): This endpoint retrieves details of a specific materialization job associated with a workbook by materializationId. It provides comprehensive information including status, start and completion times, which helps for monitoring and troubleshooting materialization. ### Usage notes - Retrieve the **materializationId** by calling the [/v2/workbooks/{workbookId}/materializations](materializeworkbookelement) endpoint. ### Usage scenarios - **Job Monitoring:** Enables administrators to track the progress and status of materialization jobs, aiding in operational oversight. - **Troubleshooting:** Provides detailed information needed to diagnose and resolve issues in materialization processes. ### Best practices - Monitor materialization jobs regularly to detect and resolve issues promptly. - Use the detailed information provided by this endpoint to optimize materialization settings and performance. - [List materialization schedules for a workbook](https://help.sigmacomputing.com/reference/listmaterializationschedules.md): **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request. This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - To retrieve additional pages of results, use the response of the `nextPage` parameter as the `page` query parameter in the following request. ### Usage scenarios - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance. - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments. ### Best practices - Regularly review materialization schedules to align them with current data usage patterns and business needs. - Use pagination to manage large sets of data and improve response times of API calls. - [List materialization schedules for a workbook (Paginated)](https://help.sigmacomputing.com/reference/v2_1_listmaterializationschedules.md): **Attention:** This API endpoint uses pagination by default. This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - To retrieve additional pages of results, use the response of the `nextPage` parameter as the `page` query parameter in the following request. ### Usage scenarios - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance. - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments. ### Best practices - Regularly review materialization schedules to align them with current data usage patterns and business needs. - Use pagination to manage large sets of data and improve response times of API calls. - [Run a scheduled materialization for a workbook element](https://help.sigmacomputing.com/reference/materializeworkbookelement.md): This endpoint runs a scheduled materialization for an element in a workbook. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance. For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization). ### Usage notes - The materialization schedule for the specified element must be created beforehand. - Retrieve the **sheetId** by calling the [/v2/workbooks/{workbookId}/materialization-schedules](listmaterializationschedules) endpoint. - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Performance optimization:** Use this endpoint to improve response times for frequently accessed workbook elements. - **Data refresh:** Allows users to manually (programmatically) refresh the data of specific workbook elements to ensure that the latest data is available for analysis and reporting. ### Best practices - Prioritize materialization for elements that are heavily used or form critical components of business reports. - Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times. - [List elements in a workbook page](https://help.sigmacomputing.com/reference/listworkbookpageelements.md): This endpoint retrieves all elements from a specific page within a workbook, which lets you understand and interact with the individual components that make up the page, such as charts, tables, or controls. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](listworkbookpages) endpoint. - To retrieve pages from version-tagged workbooks, pass the `tag` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](listworkbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve pages from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](listworkbookbookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](listtaggedworkbookbookmarks) endpoints. ### Usage scenarios - **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation. - **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with. ### Best practices - Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience. - Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls. - [List workbook pages for a workbook](https://help.sigmacomputing.com/reference/listworkbookpages.md): This endpoint retrieves a list of all pages contained within a specified workbook. It is useful for applications needing to display an overview or navigate through different pages of a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - To retrieve pages from version-tagged workbooks, pass the `tag` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](listworkbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve pages from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](listworkbookbookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](listtaggedworkbookbookmarks) endpoints. ### Usage scenarios - **Navigation:** Helps users and applications navigate through different pages of a workbook efficiently. - **Content Discovery:** Allows users to quickly view and access the variety of pages contained within a workbook. ### Best practices - Always name pages to make it easy for users to navigate. - Utilize pagination to manage and streamline the retrieval of large numbers of pages. - Ensure that users or systems querying this endpoint have appropriate permissions to access the workbook's content. - [Remove a tag from a workbook](https://help.sigmacomputing.com/reference/deletetaggedworkbook.md): This endpoint removes a specific version tag from a workbook. Version tags are used to mark workbooks for certain stages or characteristics. Removing a version tag can help manage and update the organizational scheme of workbooks as projects evolve or conclude. ### Usage notes - **workbookId:** The unique identifier for the workbook to remove the tag from. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - **tagId:** The unique identifier for the tag to remove. Retrieve the **tagId** by calling the [/v2/tags](listversiontag) endpoint and using the `versionTagId` in the response. ### Usage scenarios - **Organizational updates:** Useful for administrators who need to update tagging schemes as project requirements change. - **Data management:** Helps in maintaining the relevance and organization of workbook metadata for easier access and identification. ### Best practices - Verify that the correct tag is being removed by reviewing its associated workbooks and the implications of its removal. - [Get tags for a workbook](https://help.sigmacomputing.com/reference/getworkbooktags.md): Retrieve the version tag information for a workbook. Returns the same tag metadata as the [GET /v2/workbooks](listworkbooks) endpoint returns for a tagged workbook. ### Usage notes - Use this endpoint to provide on-demand access to version tag information for a workbook. For example, call the [GET /v2/workbooks](listworkbooks) endpoint with the "excludeTags" parameter set to `True` to improve performance, then use this endpoint to return tag information for specific workbooks. - [Tag a workbook](https://help.sigmacomputing.com/reference/tagworkbook.md): Add a version tag to a workbook and optionally set up a connection to swap to for a specific version of the workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **tag** by calling the [/v2/tags](listversiontag) endpoint and using the `name` in the response. - Retrieve the **connectionId** to use as the **fromId** or **toId** by calling the [/v2/connections](listconnections) endpoint. - If your workbook includes a source that is not mapped to a new source, that source is not swapped. - When swapping data models used as the source for the workbook: - You can only swap a data model source to another version of the same data model source. You cannot swap a data model source to a table in your data warehouse or a dataset. - When you swap sources from one data model version to a new one, specify the version tag of the data model that you swap to with `toVersionTagId`: - To swap to the latest published version of the data model, specify `toVersionTagId` as `null`. - To swap to a specific tagged version of the data model, specify the `toVersionTagId` of the data model. - If the workbook already uses a specific tagged version of a data model as a source, use `fromVersionTagId` to indicate which tagged version to swap from. - To swap from the latest published version of the data model, specify `fromVersionTagId` as `null`. - To swap from a specific tagged version of the data model, specify the `fromVersionTagId` of the data model. - To retrieve the `fromVersionTagId` for a data model used as the workbook source, call the [/v2/workbooks/{workbookId}/sources](getworkbooksources) endpoint and use the `versionTagId` in the response. - To retrieve the `versionTagId` for a data model, call the [/v2/dataModels](listdatamodels) endpoint and use the `versionTagId` in the response. ### Usage scenarios - **Lifecycle management**: Identify production and development resources. - [Duplicate a tagged workbook](https://help.sigmacomputing.com/reference/copytaggedworkbook.md): This endpoint lets you duplicate a tagged workbook, creating a new workbook from the tagged version. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups. ### Usage notes - The workbookId and version tag in the URL specify the tagged version of the workbook to duplicate. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. For the **versionTag**, you can specify either the tag name or ID. Retrieve the version tag name or ID by calling the [/v2/tags](listVersionTags) endpoint. - The `destinationFolderId` in the request body specifies where to place the new workbook. - To use the "My Documents" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](getmember) endpoint and use the `homeFolderId` included in the response. - Retrieve the **folderId** of all folders by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Best practices - Always verify that the destination folder has the correct permissions set to avoid access issues. - [Duplicate a workbook](https://help.sigmacomputing.com/reference/copyworkbook.md): This endpoint lets you duplicate an existing workbook. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups. ### Usage notes - The `workbookId` in the URL specifies the original workbook to be copied. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - The `destinationFolderId` in the request body specifies where to place the new workbook. - To use the "My Documents" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](getmember) endpoint and use the `homeFolderId` included in the response. - Retrieve the **folderId** of all folders by calling the [/v2/files](fileslist) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Reuse**: Use an existing workbook as a baseline for a "one-off" purpose instead of a template. - **Template creation**: Create a copy of a workbook to serve as a template for future projects. - **Backup**: Make a backup of a workbook before making significant changes. [Version tagging](https://help.sigmacomputing.com/docs/version-tagging) is also a useful way to accomplish this. ### Best practices - Always verify that the destination folder has the correct permissions set to avoid access issues. - When using as a template, ensure that all data connections are correctly configured to prevent data leaks or errors. ### Copying bookmarks - Set `copyBookmarks` to `all` to copy every saved view (formerly "bookmarks") applied to the source workbook. This is available to admins only. - Set `copyBookmarks` to `accessible` to copy personal saved views and those shared with the user initiating the operation. - Ownership of all copied bookmarks transfers to the user initiating the copy operation. - [Get version history for a workbook](https://help.sigmacomputing.com/reference/getversionhistory.md): Get version history for a workbook given the workbookId. If the version history contains any tagged versions, the response includes information about the version tag. - [Get a workbook](https://help.sigmacomputing.com/reference/getworkbook.md): This endpoint retrieves a workbook by its unique identifier (`workbookId`). It provides detailed information about the workbook, including its name, URL, path, and other metadata. You can use this endpoint to fetch specific workbook details for display or further processing within client applications. ### Usage notes - The **workbookId** parameter must be a valid UUID that uniquely identifies the workbook. Invalid or nonexistent IDs return an error. Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific workbook to display its content or metadata in a custom user interface. - **Integration**: This endpoint is crucial for integrations where other systems need to fetch workbook details based on an ID provided through another interface or workflow. ### Best practices - Validate the **workbookId** on the client side before making a request to avoid unnecessary server load caused by invalid requests. - [List columns for all elements in a workbook](https://help.sigmacomputing.com/reference/getworkbookcolumns.md): This endpoint retrieves all columns in a workbook for all element in the workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Data exploration:** Enable users to explore the data structure of a workbook element, facilitating deeper analysis and understanding. - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately. ### Best practices - Use this endpoint when setting up interfaces that require specific knowledge about the data structure. - [List workbook controls](https://help.sigmacomputing.com/reference/getworkbookcontrols.md): This endpoint retrieves all controls associated with a specific workbook. Controls are interactive elements like checkboxes, or dropdowns used within the workbook for dynamic data interaction. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Dynamic data interaction:** Allows users to interact dynamically with the data presented in the workbook through various control mechanisms. - **Custom reporting:** Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements. ### Best practices - Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation. - Use detailed and descriptive names for controls to facilitate easier identification and use by end users. - [Get workbook schema](https://help.sigmacomputing.com/reference/getworkbookschema.md): The Workbook Schema API is deprecated as of December 15, 2023. This endpoint is no longer compatible with workbook layouts. Workflows that use this endpoint must be replaced with the new endpoints listed below. The components in Workbook Schema API are available through individual endpoints to minimize the retrieval of unnecessary data. - [GET v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/listworkbookpages) - [GET v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/listworkbookpageelements) - [GET v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/listworkbookqueries) - [GET v2/workbooks/{workbookId}/elements/{elementId}/query](https://help.sigmacomputing.com/reference/getelementquery) - [List workbook sources](https://help.sigmacomputing.com/reference/getworkbooksources.md): Get the data sources of a workbook given the workbookId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - [List lineage for a workbook](https://help.sigmacomputing.com/reference/listlineagetree.md): This endpoint lists the elements, data sources, and upstream lineage for those data sources in a workbook, providing a detailed view of how data is interconnected within a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements. - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or workbook structure. - **Data source management**: Identify the dependencies of data sources in use in a specific workbook. ### Best practices - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams. - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized. - [List elements in a workbook](https://help.sigmacomputing.com/reference/listworkbookelements.md): This endpoint retrieves all elements in a workbook, which lets you understand and interact with the individual components that make up the workbook, such as charts, tables, or controls. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - To retrieve elements from version-tagged workbooks, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](listworkbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve elements from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](listworkbookbookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](listtaggedworkbookbookmarks) endpoints. ### Usage scenarios - **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation. - **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with. ### Best practices - Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience. - Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls. - [List SQL queries in a workbook](https://help.sigmacomputing.com/reference/listworkbookqueries.md): This endpoint retrieves a list of all SQL queries stored within a specific workbook. It is useful for developers and analysts who need to review or audit the queries being used for data manipulation and reporting within the workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. ### Usage scenarios - **Audit and review:** Enables administrators and data governance teams to audit and review all the queries associated with a workbook for compliance and optimization. - **Query optimization:** Allows users to identify and optimize potentially inefficient or slow queries to improve performance. ### Best practices - Use pagination to manage large sets of queries efficiently, especially in workbooks with extensive data manipulation. - Regularly review queries as part of data governance practices to ensure they remain up to date and perform optimally. - [Save a template from a workbook](https://help.sigmacomputing.com/reference/savetemplatefromworkbook.md): Create a workbook template from an existing workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - The template owner defaults to the user associated with the API credentials. You can specify an owner in the request body with the `ownerId`. Retrieve the user ID to use as the ownerID by calling the [/v2/members](listmembers) endpoint and using the `memberId` included in the response. - [Swap workbook data sources](https://help.sigmacomputing.com/reference/sourceswapworkbook.md): Swap the data sources used by a workbook. You can swap from one connection to another, and/or from one dataset or table to another. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint. - Retrieve the **connectionId** by calling the [/v2/connections](listconnections) endpoint. - Retrieve the sources used by a workbook from the [v2/workbooks/{workbookId}/sources](getworkbooksources) endpoint. - To swap all tables in a connection, set the `swapTables` option to `true`. - Use the `paths` option to specify the connection paths to swap. The connection path is a list of strings that represents the path to the table in the cloud data warehouse. For example, `["database", "schema", "table"]`. - If the table schema is the same in both connections, leave the `paths` option empty to swap all tables in the connection. You can also pass a partial path to swap between databases, catalogs, or schemas. - If `sourceMapping` is provided, those mappings take precedence over the connection swaps. - If `swapTables` is not set to `true`, only Custom SQL elements have their connections changed. ### Usage scenarios - **Workbook development**: Use a test data source while developing a workbook, then swap the source to a production database when ready to share the workbook for production use. - [Create a workspace](https://help.sigmacomputing.com/reference/createworkspace.md): This endpoint allows clients to create a workspace with specific characteristics. ### Usage notes - Set **NoDuplicates** to **true** to prevent the creation of a workspace with a name that already exists. ### Usage scenarios - **Initial setup**: Useful for users setting up a new workspace after signing up. - **Project separation**: Helps in creating separate workspaces for different projects or teams. ### Best practices - **Check for existing names**: Before setting `noDuplicates` to true, make sure to search for existing workspace names to avoid conflicts. - **Consistent naming conventions**: Adopt a consistent naming convention for workspaces to ensure clarity and avoid confusion. - [List workspaces](https://help.sigmacomputing.com/reference/listworkspaces.md): **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request. This endpoint returns a list of all workspaces. You can use pagination and optionally filter by name to manage large sets of data. See [Manage Workspaces](doc:manage-workspaces) for more details about workspaces in Sigma. ### Usage notes - **Filtering by name**: Optionally, use the `name` parameter to filter workspaces by a case-insensitive substring match. - **Filtering by exact name**: Optionally, use the `exactName` parameter to filter workspaces by an exact name match (also case-insensitive). When provided, `exactName` takes precedence over `name` and uses an indexed equality lookup, which is significantly faster than substring search. ### Usage scenarios - **Pagination**: Use the `page` and `limit` parameters to control the size and segment of the workspace list returned. - **User interface display**: Populate a user interface with a list of all available workspaces, using pagination to efficiently load data and filtering to quickly find specific workspaces. - **Administrative overview**: Provide system administrators with an overview of all workspaces for management and monitoring purposes, with the ability to browse through pages and search by name. ### Best practices - Use caching to reduce load times and server demand when frequently accessing workspace lists. - Regularly update and synchronize workspace lists to ensure that displayed information is current and accurate. - [List workspaces (Paginated)](https://help.sigmacomputing.com/reference/v2_1_listworkspaces.md): **Attention:** This API endpoint uses pagination by default. This endpoint returns all workspaces. See [Manage Workspaces](doc:manage-workspaces) for more details about workspaces in Sigma. ### Usage notes - **Pagination**: Use the `page` and `limit` parameters to control the size and segment of the workspace list returned. - **Filtering by name**: Optionally, use the `name` parameter to filter workspaces by a case-insensitive substring match. - **Filtering by exact name**: Optionally, use the `exactName` parameter to filter workspaces by an exact name match (also case-insensitive). When provided, `exactName` takes precedence over `name` and uses an indexed equality lookup, which is significantly faster than substring search. ### Usage scenarios - **User interface display**: Populate a user interface with a list of all available workspaces, using pagination to efficiently load data and filtering to quickly find specific workspaces. - **Administrative overview**: Provide system administrators with an overview of all workspaces for management and monitoring purposes, with the ability to browse through pages and search by name. ### Best practices - Use caching to reduce load times and server demand when frequently accessing workspace lists. - Regularly update and synchronize workspace lists to ensure that displayed information is current and accurate. - [Delete a workspace](https://help.sigmacomputing.com/reference/deleteworkspace.md): You can use this endpoint to delete an existing workspace by its workspaceId. **Caution:** Deleted workspaces cannot be recovered. ### Usage notes - Retrieve the **workspaceId** by calling the [/v2/workspaces](listworkspaces) endpoint. ### Usage scenarios - **Cleanup operations**: Useful for removing workspaces that are no longer needed or relevant. - **Resource management**: Helps in managing the overall resource allocation by removing unused workspaces. ### Best practices - **Confirm before deletion**: Always ensure that deletion operations are preceded by explicit user confirmations to prevent accidental loss of data. - **Audit and logging**: Maintain audit logs for deletion actions to track who deleted the workspace and when. - [Get a workspace](https://help.sigmacomputing.com/reference/getworkspace.md): This endpoint retrieves the details of a specific workspace by its workspaceId. ### Usage notes - Retrieve the **workspaceId** by calling the [/v2/workspaces](listworkspaces) endpoint. ### Usage scenarios - **Workspace management**: Useful for administrators or users who need to view the details of a specific workspace. - **Integration checks**: Can be used by external systems to verify the existence and status of a workspace as part of integration workflows. ### Best practices - **Validate workspaceId**: Ensure the workspaceId provided is valid and corresponds to an existing workspace. Handle any errors gracefully. - **Access controls**: Implement proper authorization checks to ensure that only entitled users can access workspace details. - [Grant permissions to the workspace for users or teams](https://help.sigmacomputing.com/reference/createworkspacegrant.md): This endpoint allows creating a grant which specifies permissions for one or more users or teams to access a workspace. ### Usage notes - **Grants**: An array of grant objects. Each object specifies a grantee and the permission level assigned to them. - Retrieve the **workspaceId** by calling the [/v2/workspaces](listworkspaces) endpoint. - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant. - Retrieve the **memberId** by calling the [/v2/members](listmembers) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](listteams) endpoint. ### Usage scenarios - **Access control setup**: Use this endpoint to set up or modify access controls for a workspace, specifying which users or teams can access and what actions they can perform. ### Best practices - **Clear permission definitions**: Ensure that the permissions granted are well understood by both the grantor and the grantee to avoid misuse of access rights. - [Delete a workspace grant](https://help.sigmacomputing.com/reference/deleteworkspacegrant.md): Delete a specific grant of permissions granted on a workspace to a user or team. ### Usage notes - Retrieve the **workspaceId** by calling the [/v2/workspaces](listworkspaces) endpoint. - Retrieve the **grantId** by calling the [/v2/workspaces/{workspaceId}/grants](listworkspacegrants) endpoint. - [List grants for a workspace](https://help.sigmacomputing.com/reference/listworkspacegrants.md): This endpoint retrieves a list of all permission grants associated with a specific workspace, identified by its workspaceId. ### Usage notes - Retrieve the **workspaceId** by calling the [/v2/workspaces](listworkspaces) endpoint. - Optionally use the `page` and `limit` parameters to manage the size of the returned data and navigate through large sets of data. ### Usage scenarios - **Access control management**: Useful for administrators to review and manage who has what access to the workspace. - **Audit and compliance**: Assists in compliance checks and audits by providing a clear view of the permissions granted to different users and teams. ### Best practices - **Use pagination**: Especially important for workspaces with a large number of grants to ensure performance and usability. - **Regular review**: Regularly review and update the workspace grants to ensure they align with current organizational policies and user roles. - [Update a workspace](https://help.sigmacomputing.com/reference/updateworkspace.md): This endpoint updates the name of an existing workspace identified by its workspaceId. ### Usage notes - Set `NoDuplicates` to `true` to prevent the creation of a duplicate workspace. - Retrieve the **workspaceId** by calling the [/v2/workspaces](listworkspaces) endpoint. ### Usage scenarios - **Configuration change**: Allows users to update workspace settings or names as projects evolve or requirements change. - **Access control adjustments**: Update workspace details in response to organizational changes or policy updates. ### Best practices - **Partial updates**: Use PATCH to support partial updates, only sending the fields that need to be updated. - **Validation**: Validate input data to ensure it adheres to expected formats and constraints. Handle errors gracefully and inform the user of any constraints. ## Recipes - [Authentication: Get Access Token (JavaScript)](https://help.sigmacomputing.com/recipes/authentication-get-access-token-javascript.md) - [Connections: List all (Javascript)](https://help.sigmacomputing.com/recipes/connections-list-all-javascript.md) - [Connections: Sync All Tables in Schema (Javascript)](https://help.sigmacomputing.com/recipes/connections-sync-all-tables-in-schema-javascript.md) - [Embedding - Generate Embed Path for Member - All Workbooks (JavaScript)](https://help.sigmacomputing.com/recipes/embedding-generate-embed-path-for-member-all-workbooks-javascript.md) - [Get Column Names by Page and Element (Javascript)](https://help.sigmacomputing.com/recipes/get-column-names-by-page-and-element-javascript.md) - [Member - Get Member Details (JavaScript)](https://help.sigmacomputing.com/recipes/member-get-member-details-javascript.md) - [Member: Onboarding (JavaScript)](https://help.sigmacomputing.com/recipes/member-onboarding-javascript.md) - [Members: Bulk Deactivate](https://help.sigmacomputing.com/recipes/members-bulk-deactivate.md) - [Members: Change Email Address (JavaScript)](https://help.sigmacomputing.com/recipes/members-change-email-address-javascript.md) - [Members: Create New (JavaScript)](https://help.sigmacomputing.com/recipes/members-create-new-javascript.md) - [Members: List All (JavaScript)](https://help.sigmacomputing.com/recipes/members-list-all-javascript.md) - [Members: Recent Workbooks (JavaScript)](https://help.sigmacomputing.com/recipes/members-recent-workbooks-javascript.md) - [Members: Update (JavaScript)](https://help.sigmacomputing.com/recipes/members-update-javascript.md) - [Teams: Bulk Assign Members (JavaScript)](https://help.sigmacomputing.com/recipes/teams-bulk-assign-members-javascript.md) - [Teams: Bulk Remove Members (JavaScript)](https://help.sigmacomputing.com/recipes/teams-bulk-remove-members-javascript.md) - [Tenants: Bulk Sync Connection Paths (JavaScript)](https://help.sigmacomputing.com/recipes/tenants-bulk-sync-connection-paths-javascript.md) - [Workbook - Copy Workbook to Member "My Documents" Folder (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-copy-workbook-to-member-my-documents-folder-javascript.md) - [Workbook: Export to CSV with Date Range Parameters (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-export-to-csv-with-date-range-parameters-javascript.md) - [Workbook: Export to PDF (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-export-to-pdf-javascript.md) - [Workbook: Initiate Materialization Job (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-initiate-materialization-job-javascript.md) - [Workbook: List All (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-list-all-javascript.md) - [Workbook: Pagination (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-pagination-javascript.md) - [Workbook: Reassign Ownership by Email (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-reassign-ownership-by-email.md) - [Workbook: Shared with Me (JavaScript)](https://help.sigmacomputing.com/recipes/workbook-shared-with-me-javascript.md) - [Workbooks: List all Input Tables (JavaScript)](https://help.sigmacomputing.com/recipes/workbooks-list-all-input-tables-javascript.md) - [Workbooks - Update owner (Javascript)](https://help.sigmacomputing.com/recipes/workbooks-update-owner-javascript.md) ## Changelog - [What's new in Sigma](https://help.sigmacomputing.com/changelog/2026-06-26.md) - [What's new in Sigma](https://help.sigmacomputing.com/changelog/2026-06-18.md) - [What's new in Sigma](https://help.sigmacomputing.com/changelog/2026-06-12.md) - [What's new in Sigma](https://help.sigmacomputing.com/changelog/2026-06-05.md) - [What's new in Sigma](https://help.sigmacomputing.com/changelog/2026-05-29.md)