workbooks_list_workbooks
Workbooks List Workbooks
List all workbooks in the organization. Pass summary_only=True for concise token-efficient response.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limitsummary_only
workbooks_get_workbook
Workbooks Get Workbook
Get workbook metadata.
输入参数workbook_id必填
workbooks_create_workbook
Workbooks Create Workbook
Create an empty workbook in a folder.
输入参数name必填folder_id必填description
workbooks_duplicate_workbook
Workbooks Duplicate Workbook
Duplicate an existing workbook.
workbook_id: ID of the workbook to clone.
name: Name for the new cloned workbook (required by the API).
destination_folder_id: ID of the destination folder. If omitted, clones into the same folder as the original.
输入参数name必填workbook_id必填destination_folder_id
workbooks_list_workbook_pages
Workbooks List Workbook Pages
List pages in a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_list_workbook_lineage
Workbooks List Workbook Lineage
List data lineage for a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_get_workbook_version_history
Workbooks Get Workbook Version History
Get version history for a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_restore_workbook_version
Workbooks Restore Workbook Version
Restore a workbook to a previous version.
输入参数version必填workbook_id必填
workbooks_convert_workbook_to_report
Workbooks Convert Workbook To Report
Convert a workbook to a report (one-way, creates a new report).
workbook_id: ID of the workbook to convert.
name: Name for the new report (required by the API).
destination_folder_id: Optional folder ID for the report; defaults to My Documents.
输入参数name必填workbook_id必填destination_folder_id
workbooks_list_workbook_grants
Workbooks List Workbook Grants
List permission grants on a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_grant_workbook_access
Workbooks Grant Workbook Access
Grant access to a workbook. grant_type: 'member' or 'team'. permission: 'view', 'explore', 'edit'.
输入参数grant_type必填grantee_id必填permission必填workbook_id必填
workbooks_list_workbook_embeds
Workbooks List Workbook Embeds
List embed configurations for a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_create_workbook_embed
Workbooks Create Workbook Embed
Create an embed for a workbook.
embed_type: Visibility of the embed. Only 'public' is currently supported.
source_type: Scope of the embed — 'workbook' (entire workbook), 'page', or 'element'.
source_id: Required when source_type is 'page' or 'element'.
输入参数source_idembed_typesource_typeworkbook_id必填
workbooks_export_workbook
Workbooks Export Workbook
Export a workbook element. If element_id is empty, exports the first page.
format: 'pdf', 'png', 'csv', 'xlsx', 'json', 'jsonl'.
layout: 'portrait' or 'landscape' (only for pdf/png).
element_id: The specific element to export. If omitted, uses the first page element.
输入参数formatlayoutelement_idworkbook_id必填
workbooks_list_workbook_schedules
Workbooks List Workbook Schedules
List every scheduled export for a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_add_workbook_schedule
Workbooks Add Workbook Schedule
Create a scheduled export for a workbook. See Sigma docs for schedule body schema.
输入参数body必填workbook_id必填
workbooks_delete_workbook_schedule
Workbooks Delete Workbook Schedule
Delete a scheduled export. Requires confirm=True.
输入参数confirmschedule_id必填workbook_id必填
workbooks_list_workbook_bookmarks
Workbooks List Workbook Bookmarks
List bookmarks (saved filter states) in a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_add_workbook_bookmark
Workbooks Add Workbook Bookmark
Add a bookmark to a workbook.
输入参数body必填workbook_id必填
workbooks_get_workbook_tags
Workbooks Get Workbook Tags
List tags on a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
workbooks_tag_workbook
Workbooks Tag Workbook
Apply a version tag to a workbook by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.
输入参数tag_name必填workbook_id必填
workbooks_remove_workbook_tag
Workbooks Remove Workbook Tag
Remove a tag from a workbook. Requires confirm=True.
输入参数tag_id必填confirmworkbook_id必填
workbooks_list_templates
Workbooks List Templates
List all templates in the organization.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limit
workbooks_get_template
Workbooks Get Template
Get template details.
输入参数template_id必填
workbooks_create_workbook_from_template
Workbooks Create Workbook From Template
Create a workbook from a template. This brings real visuals — the only programmatic way to get charts/tables.
输入参数namefolder_id必填template_id必填
workbooks_save_template_from_workbook
Workbooks Save Template From Workbook
Save a workbook as a reusable template.
输入参数namefolder_id必填workbook_id必填
workbooks_list_reports
Workbooks List Reports
List all reports in the organization.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limit
workbooks_get_report
Workbooks Get Report
Get report metadata.
输入参数report_id必填
workbooks_create_report
Workbooks Create Report
Create a report.
输入参数body必填
workbooks_duplicate_report
Workbooks Duplicate Report
Duplicate a report.
report_id: ID of the report to clone.
name: Name for the new cloned report (required by the API).
destination_folder_id: ID of the destination folder to clone into (required by the API).
输入参数name必填report_id必填destination_folder_id必填
workbooks_list_report_sources
Workbooks List Report Sources
List data sources used by a report.
输入参数report_id必填
workbooks_list_report_elements
Workbooks List Report Elements
List elements in a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_list_report_queries
Workbooks List Report Queries
List SQL queries in a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_list_report_lineage
Workbooks List Report Lineage
List lineage for a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_export_report
Workbooks Export Report
Export a report. format: 'pdf', 'png', 'csv', 'xlsx'.
输入参数formatreport_id必填
workbooks_list_report_schedules
Workbooks List Report Schedules
List scheduled exports for a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数report_id必填
workbooks_create_report_schedule
Workbooks Create Report Schedule
Create a scheduled export for a report.
输入参数body必填report_id必填
workbooks_list_shared_templates
Workbooks List Shared Templates
List templates shared with your organization from other orgs.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
无需输入参数。
workbooks_accept_shared_template
Workbooks Accept Shared Template
Accept a pending template share from another organization.
输入参数share_id必填
workbooks_copy_workbook_to_member
Workbooks Copy Workbook To Member
Copy a workbook into a member's My Documents folder.
name: Optional name for the copied workbook. Defaults to the original workbook name.
输入参数namemember_id必填workbook_id必填
workbooks_deploy_template_to_folder
Workbooks Deploy Template To Folder
Full deployment: instantiate a template into a folder, then optionally swap its sources.
输入参数name必填folder_id必填template_id必填connection_mapping
workbooks_promote_workbook
Workbooks Promote Workbook
Promote a workbook by tagging it (e.g., 'Production'). Creates tag if it doesn't exist.
输入参数tag_name必填tag_colorworkbook_id必填
workbooks_export_and_download
Workbooks Export And Download
Export a workbook/element and download the result. Polls until ready.
format: 'csv', 'pdf', 'xlsx', 'png'. layout: 'portrait' or 'landscape' (pdf only).
parameters: Sigma control overrides e.g. {'DateRange': 'min:2024-01-01,max:2024-01-31'}.
max_bytes: maximum allowed response size (default 10 MB). Returns size info without
content if exceeded.
Returns base64-encoded file content on success.
输入参数formatlayoutmax_byteselement_idparametersworkbook_id必填timeout_seconds
workbooks_reassign_workbook_ownership
Workbooks Reassign Workbook Ownership
Transfer all workbooks from one member to another.
Resolves members by email, finds all workbooks owned by old owner, then
PATCHes /v2/files/{id} to reassign. dry_run=True (default) reports what
would change without making changes. Both arguments must be email addresses (Sigma looks
members up by email only), and each must match exactly one member's email, ignoring case;
otherwise the call fails before any change.
输入参数dry_runnew_owner_email必填old_owner_email必填
workbooks_list_workbooks_shared_with_member
Workbooks List Workbooks Shared With Member
List all workbooks accessible to a member with full workbook metadata.
Cross-references member's file list against the full workbook catalog.
输入参数member_id必填
workbooks_list_all_workbooks
Workbooks List All Workbooks
List ALL workbooks in the organization, automatically following pagination.
无需输入参数。
workbooks_list_all_reports
Workbooks List All Reports
List ALL reports in the organization, automatically following pagination.
无需输入参数。
workbooks_update_workbook_contents
Workbooks Update Workbook Contents
Update a workbook from a code representation (JSON document specification).
Mutating operation. Requires confirm=True and document_version integer to guard
against concurrent overwrites.
输入参数confirmcontents必填workbook_id必填document_version必填
workbooks_verify_workbook_spec
Workbooks Verify Workbook Spec
Verify a workbook code representation specification without saving.
Validates schema structure, syntax, and element layout through a dry run of workbook
creation (``dryRun: true``). Returns ``{valid, errors, warnings}``. A success that does
not echo ``dryRun: true`` fails the call (``dry_run_not_honored``) and names any ID that
came back, since Sigma may then have created a real workbook.
输入参数name必填document必填folder_id必填description
workbooks_update_report_contents
Workbooks Update Report Contents
Update a report from a code representation (JSON document specification).
Mutating operation. Requires confirm=True and document_version integer to guard
against concurrent overwrites.
输入参数confirmcontents必填report_id必填document_version必填
workbooks_verify_report_spec
Workbooks Verify Report Spec
Verify a report code representation specification without saving.
Runs report creation as a dry run (``dryRun: true``). Returns ``{valid, errors, warnings}``.
A success that does not echo ``dryRun: true`` fails the call (``dry_run_not_honored``) and
names any ID that came back, since Sigma may then have created a real report.
输入参数name必填document必填folder_id必填description
workbooks_download_query_export
Workbooks Download Query Export
Download an exported query result file by queryId.
Returns the file content (JSON or text/CSV) or base64 binary (PDF, XLSX, PNG),
or reports 'processing' if the query has not finished executing.
max_bytes: Maximum allowed payload size in bytes (default 10 MB).
输入参数query_id必填max_bytes
workbooks_list_workbook_agents
Workbooks List Workbook Agents
List AI agents defined in a specific workbook (optionally filtering by version tag).
Returns Sigma's single response. The spec documents no page-token request parameter for
this endpoint, so a ``nextPageToken`` in the response cannot be followed.
输入参数workbook_id必填version_tag_name
workbooks_run_workbook_agent
Workbooks Run Workbook Agent
Run an in-workbook AI agent with conversation messages.
Mutating / execution operation. Consumes LLM tokens. Requires confirm=True.
messages: List of conversation turns (role: 'user', 'assistant', 'system', 'tool' with content).
version_tag_name: Target published version tag (defaults to latest published version).
输入参数confirmagent_id必填messages必填metadatamax_turnsworkbook_id必填response_formatversion_tag_namemax_output_tokens
workbooks_delete_workbook_grant
Workbooks Delete Workbook Grant
Delete a grant (a user's or team's permission) from a workbook. Requires confirm=True.
Retrieve grant IDs with workbooks_list_workbook_grants.
输入参数confirmgrant_id必填workbook_id必填
workbooks_delete_workbook_embed
Workbooks Delete Workbook Embed
Delete an embed from a workbook. Requires confirm=True.
Retrieve embed IDs with workbooks_list_workbook_embeds. Embeds that use the embed URL stop working.
输入参数confirmembed_id必填workbook_id必填
workbooks_send_workbook
Workbooks Send Workbook
Export (send) a workbook once to one or more targets: email, Slack, Google Sheets/Drive, or a webhook.
body follows Sigma's POST /v2/workbooks/{workbookId}/send: target (list of targets), configV2 (format and
element or page to export), plus optional parameters, conditions, timeout and sendAsUser.
输入参数body必填workbook_id必填
workbooks_update_workbook_schedule
Workbooks Update Workbook Schedule
Update a workbook's scheduled export.
body may set target, schedule (cronSpec, timezone), configV2, description and suspensionAction. Retrieve
schedule IDs with workbooks_list_workbook_schedules.
输入参数body必填schedule_id必填workbook_id必填
workbooks_update_workbook_bookmark
Workbooks Update Workbook Bookmark
Update a saved view (bookmark) in a workbook.
body may set name, isShared, isDefault and exploreKey. Retrieve bookmark IDs with
workbooks_list_workbook_bookmarks.
输入参数body必填bookmark_id必填workbook_id必填
workbooks_delete_workbook_bookmark
Workbooks Delete Workbook Bookmark
Delete a saved view (bookmark) from a workbook. Requires confirm=True.
输入参数confirmbookmark_id必填workbook_id必填
workbooks_duplicate_tagged_workbook
Workbooks Duplicate Tagged Workbook
Duplicate the version of a workbook carrying a version tag into a folder as a new workbook.
tag_name is the version tag NAME (e.g. 'Production'). copy_bookmarks is "all" (every saved view; admins only)
or "accessible" (personal saved views and those shared with the caller); leave it unset to
copy none.
Returns the new workbook.
输入参数name必填tag_name必填descriptionworkbook_id必填copy_bookmarksdestination_folder_id必填
workbooks_share_workbook_cross_org
Workbooks Share Workbook Cross Org
Share a workbook with other Sigma organizations.
body requires orgSlugs (list of organization slugs) and may set shareDatasets, copyInputTableData,
sendEmail and emailMessage.
输入参数body必填workbook_id必填
workbooks_duplicate_tagged_report
Workbooks Duplicate Tagged Report
Duplicate the version of a report carrying a version tag into a folder as a new report.
tag_name is the version tag NAME. Returns the new report.
输入参数name必填tag_name必填report_id必填descriptiondestination_folder_id必填
workbooks_list_report_pages
Workbooks List Report Pages
List the pages of a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_list_report_page_elements
Workbooks List Report Page Elements
List the elements on one page of a report. Retrieve page IDs with workbooks_list_report_pages.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数page_id必填report_id必填
workbooks_list_report_columns
Workbooks List Report Columns
List the columns of every element in a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_get_report_element_query
Workbooks Get Report Element Query
Get the SQL query Sigma generates for a report element.
输入参数report_id必填element_id必填
workbooks_list_report_controls
Workbooks List Report Controls
List the controls (filters and parameters) in a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_get_report_version_history
Workbooks Get Report Version History
Get the version history of a report (published versions, who and when).
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_send_report
Workbooks Send Report
Export (send) a report once to one or more targets.
body requires targets, config and attachments, and may set parameters and timeout, per Sigma's POST
/v2/reports/{reportId}/send.
输入参数body必填report_id必填
workbooks_update_report_schedule
Workbooks Update Report Schedule
Update a report's scheduled export.
body may set target, schedule, configV2, description and suspensionAction. Retrieve schedule IDs with
workbooks_list_report_schedules.
输入参数body必填report_id必填schedule_id必填
workbooks_delete_report_schedule
Workbooks Delete Report Schedule
Delete a report's scheduled export. Requires confirm=True.
输入参数confirmreport_id必填schedule_id必填
workbooks_create_report_grant
Workbooks Create Report Grant
Grant users or teams permission on a report.
body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'view' | 'edit'}.
输入参数body必填report_id必填
workbooks_delete_report_grant
Workbooks Delete Report Grant
Delete a grant from a report. Requires confirm=True.
输入参数confirmgrant_id必填report_id必填
workbooks_list_report_tags
Workbooks List Report Tags
List the version tags on a report.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数report_id必填
workbooks_tag_report
Workbooks Tag Report
Apply a version tag to a report by tag NAME (e.g. 'Production'). The Sigma API takes the tag name here, not its ID.
输入参数tag_name必填report_id必填
workbooks_remove_report_tag
Workbooks Remove Report Tag
Remove a version tag from a report. Requires confirm=True. Retrieve tag IDs with workbooks_list_report_tags.
输入参数tag_id必填confirmreport_id必填
workbooks_delete_shared_template
Workbooks Delete Shared Template
Delete a template share. Requires confirm=True. Retrieve share IDs with workbooks_list_shared_templates.
输入参数confirmshare_id必填
datasets_list_connections
Datasets List Connections
List all connections in the Sigma organization. Pass summary_only=True for concise token-efficient response.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数summary_only
datasets_get_connection
Datasets Get Connection
Get details for a specific connection.
输入参数connection_id必填
datasets_sync_connection
Datasets Sync Connection
Force Sigma to re-index a warehouse path. Pass empty list for full sync.
输入参数pathconnection_id必填
datasets_test_connection
Datasets Test Connection
Test connectivity for a connection.
输入参数connection_id必填
datasets_list_columns_for_table
Datasets List Columns For Table
List columns for a warehouse table by its tableId.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数table_id必填
datasets_list_connection_grants
Datasets List Connection Grants
List permission grants on a connection.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数connection_id必填
datasets_add_connection_grant
Datasets Add Connection Grant
Add a grant to a connection.
grant_type: 'member' or 'team'.
permission: 'annotate' (Can Use & Annotate) or 'usage' (Can Use).
输入参数grant_type必填grantee_id必填permission必填connection_id必填
datasets_delete_connection_path_grant
Datasets Delete Connection Path Grant
Delete a grant from a connection path. DESTRUCTIVE. Requires confirm=True.
输入参数confirmgrant_id必填connection_path_id必填
datasets_list_data_models
Datasets List Data Models
List all data models in the organization. Pass summary_only=True for concise token-efficient response.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limitsummary_only
datasets_get_data_model
Datasets Get Data Model
Get data model metadata.
输入参数data_model_id必填
datasets_get_data_model_spec
Datasets Get Data Model Spec
Get the full code representation (JSON spec) of a data model — tables, columns, metrics, relationships.
输入参数data_model_id必填
datasets_create_data_model
Datasets Create Data Model
Create a data model from a JSON code representation. Must include name, folderId, schemaVersion, and pages with elements.
输入参数spec必填
datasets_update_data_model
Datasets Update Data Model
Update an existing data model from a JSON code representation (full replacement via PUT).
输入参数spec必填data_model_id必填
datasets_list_data_model_elements
Datasets List Data Model Elements
List elements in a data model.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数data_model_id必填
datasets_list_data_model_columns
Datasets List Data Model Columns
List all columns across all elements in a data model.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数data_model_id必填
datasets_swap_data_model_sources
Datasets Swap Data Model Sources
Swap data sources for a data model.
输入参数body必填data_model_id必填
datasets_list_data_model_lineage
Datasets List Data Model Lineage
List lineage for a data model.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数data_model_id必填
datasets_tag_data_model
Datasets Tag Data Model
Apply a version tag to a data model by tag NAME. The Sigma API takes the tag name here, not its ID.
输入参数tag_name必填data_model_id必填
datasets_swap_report_sources
Datasets Swap Report Sources
Swap data sources on a report. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
输入参数report_id必填source_mappingconnection_mapping
datasets_sync_all_tables_in_schema
Datasets Sync All Tables In Schema
Sync all tables in a warehouse schema so they become visible in Sigma.
输入参数schema必填database必填connection_id必填
datasets_bulk_sync_tenant_connections
Datasets Bulk Sync Tenant Connections
Sync connections across all tenant organizations.
Lists all tenants, then for each tenant: obtains a tenant-scoped token,
lists their connections, and syncs each one. Requires multi-tenant auth
(for_tenant method). Uses bounded concurrency.
NOTE: Requires PyJWT and the for_tenant() method (Phase C). Returns an
error if token exchange is not available.
输入参数dry_run
datasets_list_all_data_models
Datasets List All Data Models
List ALL data models in the organization, automatically following pagination.
无需输入参数。
datasets_create_connection
Datasets Create Connection
Create a data warehouse connection.
body requires name and details (the warehouse type and its settings) and may set description, poolSizes,
timeoutSecs and useFriendlyNames. The details may hold write-only secrets (password, privateKey,
privateKeyPassphrase, clientSecret, token, pythonSecrets): pass them only from the user's own input.
They are masked wherever Sigma's result or error echoes them.
输入参数body必填
datasets_delete_connection
Datasets Delete Connection
Delete a connection. Requires confirm=True. Workbooks and data models built on it lose their source.
输入参数confirmconnection_id必填
datasets_list_connection_paths
Datasets List Connection Paths
List connection paths (databases, schemas and tables) across all connections.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
无需输入参数。
datasets_lookup_connection_path
Datasets Lookup Connection Path
Look up the object at a fully qualified path in a connection, e.g. ["DATABASE", "SCHEMA", "TABLE"] for Snowflake.
Read-only: the POST only resolves the path.
输入参数path必填connection_id必填
datasets_delete_connection_grant
Datasets Delete Connection Grant
Delete a grant from a connection. Requires confirm=True. Retrieve grant IDs with datasets_list_connection_grants.
输入参数confirmgrant_id必填connection_id必填
datasets_list_connection_path_grants
Datasets List Connection Path Grants
List grants on a connection path (database, schema or table).
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数connection_path_id必填
datasets_add_connection_path_grant
Datasets Add Connection Path Grant
Add grants to a connection path.
body requires grants: a list of {grantee: {memberId} or {teamId}, permission: 'annotate' | 'usage'}.
输入参数body必填connection_path_id必填
datasets_list_data_model_sources
Datasets List Data Model Sources
List the sources (tables, datasets, other data models) a data model reads from.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数data_model_id必填
datasets_materialize_data_model
Datasets Materialize Data Model
Run the scheduled materialization for one data model element now.
sheet_id is the element's ID. Returns the materialization job; poll it with
datasets_get_data_model_materialization.
输入参数sheet_id必填data_model_id必填
datasets_get_data_model_materialization
Datasets Get Data Model Materialization
Get the status of a data model materialization job.
输入参数data_model_id必填materialization_id必填
datasets_list_data_model_materialization_schedules
Datasets List Data Model Materialization Schedules
List the materialization schedules of a data model.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数data_model_id必填
datasets_list_data_model_tags
Datasets List Data Model Tags
List the version tags on a data model.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数data_model_id必填
elements_list_workbook_page_elements
Elements List Workbook Page Elements
List elements on a specific page of a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数page_id必填workbook_id必填
elements_list_workbook_elements
Elements List Workbook Elements
List all elements (tables, charts, controls, etc.) in a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
elements_list_workbook_columns
Elements List Workbook Columns
List all columns across all elements in a workbook, including formulas and types.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
elements_list_workbook_queries
Elements List Workbook Queries
List generated SQL queries for all elements in a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
elements_list_workbook_controls
Elements List Workbook Controls
List control elements (filters, parameters) in a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
elements_list_workbook_sources
Elements List Workbook Sources
List data sources used by a workbook.
输入参数workbook_id必填
elements_swap_workbook_sources
Elements Swap Workbook Sources
Swap data sources for a workbook. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
输入参数workbook_id必填source_mappingconnection_mapping
elements_get_element_query
Elements Get Element Query
Get the generated SQL query for a specific element in a workbook.
输入参数element_id必填workbook_id必填
elements_get_element_columns
Elements Get Element Columns
List columns for a specific element in a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数element_id必填workbook_id必填
elements_materialize_element
Elements Materialize Element
Trigger materialization for a workbook. Pass elementId in body if needed.
输入参数element_id必填workbook_id必填
elements_get_materialization_job
Elements Get Materialization Job
Check status of a materialization job.
输入参数job_id必填workbook_id必填
elements_list_materialization_schedules
Elements List Materialization Schedules
List every materialization schedule for a workbook.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数workbook_id必填
elements_swap_template_sources
Elements Swap Template Sources
Swap data sources on a template. Use connectionMapping for connection-level swaps, sourceMapping for table-level swaps.
输入参数template_id必填source_mappingconnection_mapping
elements_list_source_swap_policies
Elements List Source Swap Policies
List all source swap policies (rules for automatic source swapping on deployment).
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
无需输入参数。
elements_get_source_swap_policy
Elements Get Source Swap Policy
Get a source swap policy.
输入参数policy_id必填
elements_create_source_swap_policy
Elements Create Source Swap Policy
Create a source swap policy for automated deployments.
输入参数body必填
elements_materialize_and_wait
Elements Materialize And Wait
Trigger materialization and poll until complete or timeout.
输入参数element_id必填workbook_id必填timeout_seconds
elements_list_all_input_tables
Elements List All Input Tables
Scan all workbooks to find input-table elements.
Returns a list of input tables with their workbook, page, and element context.
Errors on individual workbooks/pages are collected rather than silently swallowed.
无需输入参数。
elements_formula_pitfalls
Elements Formula Pitfalls
Return a curated reference of common Sigma formula pitfalls — column reference syntax, type requirements, NULL handling, aggregate vs row-level context, date function argument order, and metrics vs calculated columns. Use this before writing any Sigma formula expression.
无需输入参数。
elements_search_docs
Elements Search Docs
Search Sigma Computing documentation using AI-powered semantic search. Returns relevant doc passages with source URLs. Use this to answer questions about Sigma features, configuration, formulas, administration, embedding, and best practices.
read_only_hint: True
输入参数query必填
elements_get_doc_page
Elements Get Doc Page
Fetch a specific Sigma documentation page as clean Markdown. Pass the page slug (e.g. 'create-a-workbook') or a section path (e.g. 'docs/create-a-workbook'). Returns the full page content.
read_only_hint: True
输入参数page_slug必填
elements_list_element_lineage
Elements List Element Lineage
List the lineage (upstream sources and dependencies) of one workbook element.
输入参数element_id必填workbook_id必填
elements_update_source_swap_policy
Elements Update Source Swap Policy
Update a source swap policy (Beta).
body may set type, name, fromConnectionId and swaps.
输入参数body必填policy_id必填
elements_delete_source_swap_policy
Elements Delete Source Swap Policy
Delete a source swap policy (Beta). Requires confirm=True.
输入参数confirmpolicy_id必填
workspace_delete_file
Workspace Delete File
Delete a file/workbook/data model by its inode ID. Requires confirm=True.
输入参数confirminode_id必填
workspace_list_files
Workspace List Files
List files/folders. Optionally filter by parentId or type ('workbook', 'folder', 'data-model', 'template').
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数parent_idtype_filter
workspace_create_folder
Workspace Create Folder
Create a folder.
输入参数name必填parent_id必填
workspace_update_file
Workspace Update File
Update file properties (name, parentId for moving).
输入参数body必填inode_id必填
workspace_list_tags
Workspace List Tags
List all tags in the organization.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``page`` resumes
from a ``nextPage`` cursor; ``limit`` is the page size.
输入参数pagelimit
workspace_create_tag
Workspace Create Tag
Create a new tag (used for version promotion like 'Production', 'Staging').
输入参数name必填color
workspace_delete_tag
Workspace Delete Tag
Delete a tag. Requires confirm=True.
输入参数tag_id必填confirm
workspace_list_workspaces
Workspace List Workspaces
List all workspaces.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``page`` resumes
from a ``nextPage`` cursor; ``limit`` is the page size.
输入参数pagelimit
workspace_get_workspace
Workspace Get Workspace
Get workspace details.
输入参数workspace_id必填
workspace_create_workspace
Workspace Create Workspace
Create a new workspace.
输入参数name必填
workspace_delete_workspace
Workspace Delete Workspace
Delete a workspace. Requires confirm=True.
输入参数confirmworkspace_id必填
workspace_list_workspace_grants
Workspace List Workspace Grants
List permission grants on a workspace.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``page`` resumes
from a ``nextPage`` cursor; ``limit`` is the page size.
输入参数pagelimitworkspace_id必填
workspace_grant_workspace_access
Workspace Grant Workspace Access
Grant workspace access.
grant_type: 'member' or 'team'.
permission: 'view', 'explore', 'organize' (Contribute), or 'edit' (Manage).
输入参数grant_type必填grantee_id必填permission必填workspace_id必填
workspace_delete_workspace_grant
Workspace Delete Workspace Grant
Delete a permission grant from a workspace. DESTRUCTIVE. Requires confirm=True.
输入参数confirmgrant_id必填workspace_id必填
workspace_list_all_files
Workspace List All Files
List files/folders in the organization, automatically following pagination.
parent_id: Optional parent folder ID to list files within.
type_filter: Optional file type filter ('workbook', 'folder', 'data-model', 'template', 'symlink').
Note: Shortcuts/symlinks are excluded by default unless type_filter='symlink'.
输入参数parent_idtype_filter
workspace_list_member_files
Workspace List Member Files
List the files (workbooks, data models, folders) a member can access.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limitmember_id必填
workspace_list_recent_files
Workspace List Recent Files
List the files a member opened recently.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数member_id必填
workspace_get_file
Workspace Get File
Get a file's details (type, name, path, owner) by its inode ID.
输入参数inode_id必填
workspace_update_tag
Workspace Update Tag
Update a version tag.
body may set name, description and color.
输入参数body必填tag_id必填
workspace_list_workbooks_for_tag
Workspace List Workbooks For Tag
List the workbooks carrying a version tag.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数tag_id必填
workspace_update_workspace
Workspace Update Workspace
Update (rename) a workspace.
body requires name and may set noDuplicates.
输入参数body必填workspace_id必填
workspace_favorite_file
Workspace Favorite File
Add a document to a member's favorites.
输入参数inode_id必填member_id必填
workspace_unfavorite_file
Workspace Unfavorite File
Remove a document from a member's favorites. Requires confirm=True.
输入参数confirminode_id必填member_id必填
workspace_list_favorites_for_member
Workspace List Favorites For Member
List a member's favorite documents.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数member_id必填
admin_list_deployments
Admin List Deployments
List all deployment policies.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
无需输入参数。
admin_get_deployment
Admin Get Deployment
Get a deployment policy.
输入参数policy_id必填
admin_create_deployment
Admin Create Deployment
Create a deployment policy.
输入参数body必填name必填
admin_archive_deployment
Admin Archive Deployment
Delete (archive) a deployment policy. Requires confirm=True.
输入参数confirmpolicy_id必填
admin_deactivate_member
Admin Deactivate Member
Deactivate a member. Requires confirm=True.
输入参数confirmmember_id必填
admin_list_deployment_documents
Admin List Deployment Documents
List documents in a deployment policy.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
输入参数policy_id必填
admin_add_deployment_documents
Admin Add Deployment Documents
Add workbooks/reports to a deployment policy.
输入参数inode_ids必填policy_id必填
admin_list_tenants
Admin List Tenants
List all tenant organizations (for multi-tenant deployments).
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
无需输入参数。
admin_get_tenant
Admin Get Tenant
Get tenant organization details.
输入参数tenant_id必填
admin_create_tenant
Admin Create Tenant
Create a tenant organization.
输入参数bodyname必填
admin_list_api_connectors
Admin List Api Connectors
List all API connectors (custom data integrations).
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
无需输入参数。
admin_get_api_connector
Admin Get Api Connector
Get details for an API connector.
输入参数connector_id必填
admin_list_members
Admin List Members
List all members in the organization. Pass summary_only=True for concise token-efficient response.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limitsummary_only
admin_get_member
Admin Get Member
Get member details including homeFolderId.
输入参数member_id必填
admin_create_member
Admin Create Member
Create a new member. member_type: 'admin', 'creator', 'viewer'.
输入参数email必填last_name必填first_name必填member_type
admin_update_member
Admin Update Member
Update member properties (firstName, lastName, memberType, isActive, etc.).
输入参数body必填member_id必填
admin_get_current_user
Admin Get Current User
Get the current authenticated user's details.
无需输入参数。
admin_list_member_teams
Admin List Member Teams
List teams a member belongs to.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数member_id必填
admin_list_teams
Admin List Teams
List all teams. Pass summary_only=True for concise token-efficient response.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read. ``limit`` is the page size.
输入参数limitsummary_only
admin_get_team
Admin Get Team
Get team details.
输入参数team_id必填
admin_create_team
Admin Create Team
Create a new team.
输入参数name必填description
admin_delete_team
Admin Delete Team
Delete a team. Requires confirm=True.
输入参数confirmteam_id必填
admin_list_team_members
Admin List Team Members
List members of a team.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数team_id必填
admin_update_team_members
Admin Update Team Members
Add or remove members from a team. Provide lists of member IDs.
输入参数addremoveteam_id必填
admin_list_user_attributes
Admin List User Attributes
List all user attributes (used for row-level security and dynamic parameters).
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
无需输入参数。
admin_create_user_attribute
Admin Create User Attribute
Create a user attribute for RLS or dynamic parameters.
name: Attribute name (e.g. 'Region', 'CustomerID').
default_value: Default string value assigned when no override exists.
description: Optional description of the attribute.
输入参数name必填descriptiondefault_value
admin_set_user_attribute_for_teams
Admin Set User Attribute For Teams
Set a user attribute value for specific teams.
assignments: List of objects, each with 'teamId' (str) and 'value' (str).
Example: [{"teamId": "abc123", "value": "US"}]
输入参数assignments必填attribute_id必填
admin_set_user_attribute_for_tenants
Admin Set User Attribute For Tenants
Set a user attribute value for specific tenants.
assignments: List of objects, each with 'tenantOrganizationId' (str) and 'value' (str).
Example: [{"tenantOrganizationId": "org123", "value": "US"}]
输入参数assignments必填attribute_id必填
admin_get_user_attribute_users
Admin Get User Attribute Users
Get all user assignments for a user attribute.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数attribute_id必填
admin_get_user_attribute_teams
Admin Get User Attribute Teams
Get all team assignments for a user attribute.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数attribute_id必填
admin_get_user_attribute_tenants
Admin Get User Attribute Tenants
Get all tenant assignments for a user attribute.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数attribute_id必填
admin_update_user_attribute_for_users
Admin Update User Attribute For Users
Revoke a user attribute assignment for specific users. Requires confirm=True.
user_ids: List of user IDs whose attribute assignments should be removed.
Example: ["user-uuid-1", "user-uuid-2"]
To assign (not revoke), use admin_set_user_attribute_for_users instead.
输入参数confirmuser_ids必填attribute_id必填
admin_update_user_attribute_for_teams
Admin Update User Attribute For Teams
Revoke a user attribute assignment for specific teams. Requires confirm=True.
team_ids: List of team IDs whose attribute assignments should be removed.
Example: ["team-uuid-1", "team-uuid-2"]
输入参数confirmteam_ids必填attribute_id必填
admin_update_user_attribute_for_tenants
Admin Update User Attribute For Tenants
Revoke a user attribute assignment for specific tenants. Requires confirm=True.
tenant_org_ids: List of tenant organization IDs whose attribute assignments should be removed.
Example: ["org-uuid-1", "org-uuid-2"]
输入参数confirmattribute_id必填tenant_org_ids必填
admin_delete_user_attribute_for_user
Admin Delete User Attribute For User
Delete a user attribute assignment for a specific user. DESTRUCTIVE. Requires confirm=True.
输入参数confirmuser_id必填attribute_id必填
admin_delete_user_attribute_for_team
Admin Delete User Attribute For Team
Delete a user attribute assignment for a specific team. DESTRUCTIVE. Requires confirm=True.
输入参数confirmteam_id必填attribute_id必填
admin_delete_user_attribute_for_tenant
Admin Delete User Attribute For Tenant
Delete a user attribute assignment for a specific tenant. DESTRUCTIVE. Requires confirm=True.
输入参数confirmattribute_id必填tenant_org_id必填
admin_list_account_types
Admin List Account Types
List all account types (license types) in the organization.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page and ``nextPageToken`` null, since every page is read.
无需输入参数。
admin_list_grants
Admin List Grants
List grants for a specific file/workbook/data model by inodeId. Required: inodeId.
Follows Sigma's pagination to the last page and returns the keys of Sigma's page: ``entries``
from every page, ``total`` when Sigma sends it (Sigma's value), and ``nextPage`` null (``hasMore``
false where Sigma sends it) since every page is read.
输入参数inode_id必填
admin_create_grant
Admin Create Grant
Create or update a grant. Body must include inodeId, granteeId, permission, type.
输入参数body必填