Sigma Computing

List the warehouse connections configured in Sigma (Snowflake, BigQuery, Databricks, and so on)

Get a warehouse connection by ID, including its type, host, and write-back setting

Test whether Sigma can reach a warehouse connection

List the browsable paths (databases, schemas, tables) available in warehouse connections

List the organization’s version tags, used to pin published document versions (for example ‘Production’)

Create a version tag

Update a version tag’s name, description, or color

Delete a version tag

List the workbooks pinned to a version tag

List workbook templates available in the organization, including Sigma’s samples

Get a workbook template by ID, including its name, path, and latest version

Create a workbook from a template and return its workbook_id for the workbook tools

List Sigma data models — the governed, reusable datasets that workbooks build on

Get a data model by ID, including its name, folder path, owner, and latest version

List the elements (tables and joins) in a data model

List columns for every element in a data model, with labels, formulas, and data types

List the warehouse tables and other sources a data model reads from

List the lineage graph for a data model, tracing it back to warehouse tables

Browse the Sigma file tree: workspaces, folders, workbooks, data models, and reports

Get a file (inode) by ID, including its type, folder path, owner, and the caller’s permission on it

Create a workspace, folder, workbook, or report

Rename a file, change its description, move it to another folder via parent_id, transfer ownership, or restore it from…

Archive a file (workbook, folder, data model, or report) by inode ID, moving it to the trash along with a folder’s contents

Favorite a document for a member

Remove a document from a member’s favorites

List the organization’s account types (license tiers), built-in and custom

List the organization’s user attributes, used to drive row-level security and dynamic content

Get a user attribute by ID, including its type and default value

Get the member the API credentials act as, returning user_id and organization_id

List members (users) in the Sigma organization

Get a member by ID, including their account type and home_folder_id

Create a member in the Sigma organization

Update a member’s name, email, or account type, or deactivate them with is_archived=true

Deactivate a member, revoking their access while preserving their content

List the teams a member belongs to

List the files a member can access, filterable by name, inode type, or parent folder

List a member’s recently viewed files, most recent first

List the documents a member has favorited

List the scheduled exports owned by a member

List Sigma reports — the paginated, print-oriented documents

Get a report by ID, including its name, folder path, owner, and latest version

List the pages in a report

List the elements in a report

Get the warehouse SQL Sigma generates for one report element

List columns for every element in a report, each tagged with its element_id

List a report’s controls (filters and parameters)

List the data sources a report reads from

Start a PDF export of a report and return a query_id to pass to download_query

List teams in the Sigma organization

Get a team by ID, including its description and visibility

Create a team, optionally seeding it with members and creating a shared team folder

Update a team’s name, description, or visibility

Delete a team permanently

List the members of a team

Add or remove members on a team in one call

List Sigma workbooks the credentials can access, newest first

Get a Sigma workbook by ID, including its name, folder path, owner, and latest_version

Get the full schema of a workbook: every element with its columns and types

List the pages (tabs) in a workbook

List every element (table, chart, control, text, image) in a workbook, across all pages

List the elements on one workbook page

Get the warehouse SQL Sigma generates for one workbook element

List the columns of one workbook element, with labels, formulas, and data types

List columns for every element in a workbook in one call, each tagged with its element_id

List the generated warehouse SQL for every element in a workbook

List a workbook’s controls (filters and parameters)

List the data sources a workbook reads from (tables, data models, other workbooks)

List the lineage graph for a workbook: warehouse tables, data models, and elements with their upstream source IDs

Get the lineage of one workbook element, tracing it back to its sources

List a workbook’s published version history with publish times and authors

Create an empty workbook in a folder

Duplicate a workbook into a destination folder

Start an export of a workbook element or page and return a query_id

List the saved views (bookmarks) on a workbook

Create a saved view (bookmark) on a workbook, reusing the exploration of an existing one

Delete a saved view (bookmark) from a workbook

List the version tags applied to a workbook

Apply a version tag to a published workbook version

List the scheduled exports configured on a workbook

Grant a member or team access to a workbook at the view, explore, or edit level

Download the result of an export started by export_workbook or export_report, using the query_id those tools return

List workspaces in the Sigma organization

Get a workspace by ID

Create a workspace to hold shared folders and documents

Rename a workspace. Use list_workspaces to find workspace IDs

Delete a workspace permanently, along with the documents it contains

List the members and teams granted access to a workspace, with their permission levels

Grant a member or team access to a workspace at the view, explore, organize, or edit level

Revoke a member’s or team’s access to a workspace

List permission grants

Get a permission grant by ID

Grant a member or team access to any inode (folder, workbook, data model, table)

Revoke a permission grant