Skip to main content

Sigma Computing

Connector for Sigma Computing — browse workbooks, elements, and data models, export analytics data, and manage members, teams, workspaces, and permissions.

Categories: Business Intelligence, Analytics, Data & Analytics

What you can ask​

  • Export the Revenue by Region workbook element as CSV and post it to the finance channel.
  • List workbooks shared with the Sales team and flag ones untouched in 90 days.
  • Add a new analyst to the right workspace and team with view permissions.

Set up​

Sigma Computing connects with credentials from your Sigma Computing account. Have these values ready:

  • API base URL
  • Client ID
  • Client secret
  1. Go to Organization > Connectors and find Sigma Computing.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Sigma Computing offers 95 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (64)​

View and search information without changing it.

ToolWhat it does
download_queryDownload the result of an export started by export_workbook or export_report, using the query_id those tools return.
get_connectionGet a warehouse connection by ID, including its type, host, and write-back setting.
get_current_userGet the member the API credentials act as, returning user_id and organization_id.
get_data_modelGet a data model by ID, including its name, folder path, owner, and latest version.
get_element_lineageGet the lineage of one workbook element, tracing it back to its sources.
get_element_queryGet the warehouse SQL Sigma generates for one workbook element.
get_fileGet a file (inode) by ID, including its type, folder path, owner, and the caller's permission on it.
get_grantGet a permission grant by ID.
get_memberGet a member by ID, including their account type and home_folder_id.
get_reportGet a report by ID, including its name, folder path, owner, and latest version.
get_report_element_queryGet the warehouse SQL Sigma generates for one report element.
get_teamGet a team by ID, including its description and visibility.
get_templateGet a workbook template by ID, including its name, path, and latest version.
get_user_attributeGet a user attribute by ID, including its type and default value.
get_workbookGet a Sigma workbook by ID, including its name, folder path, owner, and latest_version.
get_workbook_schemaGet the full schema of a workbook: every element plus all columns with types and formulas.
get_workspaceGet a workspace by ID.
list_account_typesList the organization's account types (license tiers), built-in and custom.
list_connection_pathsList the browsable paths (databases, schemas, tables) available in warehouse connections.
list_connectionsList the warehouse connections configured in Sigma (Snowflake, BigQuery, Databricks, and so on).
list_data_model_columnsList columns for every element in a data model, with labels, formulas, and data types.
list_data_model_elementsList the elements (tables and joins) in a data model.
list_data_model_lineageList the lineage graph for a data model, tracing it back to warehouse tables.
list_data_model_sourcesList the warehouse tables and other sources a data model reads from.
list_data_modelsList Sigma data models — the governed, reusable datasets that workbooks build on.
list_element_columnsList the columns of one workbook element, with labels, formulas, and data types.
list_filesBrowse the Sigma file tree: workspaces, folders, workbooks, data models, and reports.
list_grantsList permission grants.
list_member_favoritesList the documents a member has favorited.
list_member_filesList the files a member can access, filterable by name, inode type, or parent folder.
list_member_recent_filesList a member's recently viewed files, most recent first.
list_member_schedulesList the scheduled exports owned by a member.
list_member_teamsList the teams a member belongs to.
list_membersList members (users) in the Sigma organization.
list_report_columnsList columns for every element in a report, each tagged with its element_id.
list_report_controlsList a report's controls (filters and parameters).
list_report_elementsList the elements in a report.
list_report_pagesList the pages in a report.
list_report_sourcesList the data sources a report reads from.
list_reportsList Sigma reports — the paginated, print-oriented documents.
list_tag_workbooksList the workbooks pinned to a version tag.
list_tagsList the organization's version tags, used to pin published document versions (for example 'Production').
list_team_membersList the members of a team.
list_teamsList teams in the Sigma organization.
list_templatesList workbook templates available in the organization, including Sigma's samples.
list_user_attributesList the organization's user attributes, used to drive row-level security and dynamic content.
list_workbook_bookmarksList the saved views (bookmarks) on a workbook.
list_workbook_columnsList columns for every element in a workbook in one call, each tagged with its element_id.
list_workbook_controlsList a workbook's controls (filters and parameters).
list_workbook_elementsList every element (table, chart, control, text, image) in a workbook, across all pages.
list_workbook_lineageList the lineage graph for a workbook: warehouse tables, data models, and elements with their upstream source IDs.
list_workbook_page_elementsList the elements on one workbook page.
list_workbook_pagesList the pages (tabs) in a workbook.
list_workbook_queriesList the generated warehouse SQL for every element in a workbook.
list_workbook_schedulesList the scheduled exports configured on a workbook.
list_workbook_sourcesList the data sources a workbook reads from (tables, data models, other workbooks).
list_workbook_tagsList the version tags applied to a workbook.
list_workbook_versionsList a workbook's published version history with publish times and authors.
list_workbooksList Sigma workbooks the credentials can access, newest first.
list_workspace_grantsList the members and teams granted access to a workspace, with their permission levels.
list_workspacesList workspaces in the Sigma organization.
read_query_textRead an export as text; prefer over download_query to READ.
test_connectionTest whether Sigma can reach a warehouse connection.
validate_credentialValidate the Sigma client ID, client secret, and API base URL by fetching the current member.

Write (16)​

Create or send data.

ToolWhat it does
add_favoriteFavorite a document for a member.
copy_workbookDuplicate a workbook into a destination folder.
create_fileCreate a workspace, folder, workbook, or report.
create_grantGrant a member or team access to any inode (folder, workbook, data model, table).
create_memberCreate a member in the Sigma organization. member_type is an account type name — call list_account_types first, since custom account types vary per organization.
create_tagCreate a version tag.
create_teamCreate a team, optionally seeding it with members and creating a shared team folder.
create_workbookCreate an empty workbook in a folder. folder_id is required — get one from list_files with type_filters=['folder'], or a member's home_folder_id from get_member.
create_workbook_bookmarkCreate a saved view (bookmark) on a workbook, reusing the exploration of an existing one.
create_workbook_from_templateCreate a workbook from a template and return its workbook_id for the workbook tools.
create_workbook_grantGrant a member or team access to a workbook at the view, explore, or edit level.
create_workspaceCreate a workspace to hold shared folders and documents.
create_workspace_grantGrant a member or team access to a workspace at the view, explore, organize, or edit level.
export_reportStart a PDF export of a report and return a query_id to pass to download_query.
export_workbookStart an export of a workbook element or page and return a query_id.
remove_favoriteRemove a document from a member's favorites.

Delete or overwrite (15)​

Remove or replace existing data.

ToolWhat it does
deactivate_memberDeactivate a member, revoking their access while preserving their content.
delete_fileArchive a file (workbook, folder, data model, or report) by inode ID, moving it to the trash along with a folder's contents.
delete_grantRevoke a permission grant.
delete_tagDelete a version tag.
delete_teamDelete a team permanently.
delete_workbook_bookmarkDelete a saved view (bookmark) from a workbook.
delete_workspaceDelete a workspace permanently, along with the documents it contains.
delete_workspace_grantRevoke a member's or team's access to a workspace.
tag_workbookApply a version tag to a published workbook version. 'tag' is the tag NAME, not its ID — call list_tags and use the 'name' field, or create_tag to make a new one.
update_fileRename a file, change its description, move it to another folder via parent_id, transfer ownership, or restore it from the archive with restore=true.
update_memberUpdate a member's name, email, or account type, or deactivate them with is_archived=true.
update_tagUpdate a version tag's name, description, or color.
update_teamUpdate a team's name, description, or visibility.
update_team_membersAdd or remove members on a team in one call.
update_workspaceRename a workspace.
⌘J