Sigma Computing

Duplicate an existing report to a new folder with a new name.

Duplicate an existing workbook into a specified folder. Creates a full copy of the workbook including all pages, elements, and queries. The copy uses ...

Create a new report. Reports are read-only views of workbooks used for scheduled delivery and sharing.

Revoke a permission grant. The grantee (member or team) loses access to the resource. This does not delete the resource itself.

Deactivate a member from Sigma Computing. The member loses access but their content is preserved. This cannot be undone via the API — contact Sigma su...

Delete a scheduled export from a report. The schedule stops running immediately.

Permanently delete a team. This cannot be undone. Team members are NOT deleted — they just lose the team association. Team folder and its contents rem...

Delete a scheduled export from a workbook. The schedule stops running immediately.

Permanently delete a workspace and all its contents (workbooks, datasets, files). This cannot be undone. All content in the workspace is permanently r...

Download an exported file using the queryId from sigma_computing_export_workbook. If the export is still processing, returns a status. Poll until the ...

Export a report to a file. Returns a download URL for the exported file. Formats: csv, xlsx (spreadsheet), png/pdf (visual), json (data). For large re...

Export workbook data as CSV, JSON, XLSX, PDF, or PNG. Returns a queryId — pass it to sigma_computing_download_export to download the file. Optionally ...

Get data connections in your Sigma organization. Pass connection_id for a single connection's details (type, host, warehouse, write access), or omit t...

Get all columns across all elements in a data model. Returns column names, types, and which element they belong to. Use to understand the schema a dat...

Get the elements (tables, joins, transformations) in a data model. Returns element IDs, names, and types. Use to understand the structure of a data mo...

Get the data lineage for a data model. Shows which connections, databases, schemas, and tables feed into this data model, and which workbooks consume ...

Get data models in your Sigma organization. Pass data_model_id for a single data model's details, or omit to list all. Data models are reusable transf...

Get the data sources for a data model. Returns which connections and tables the data model reads from.

Get datasets in your Sigma organization. Pass dataset_id for a single dataset's full details (source, columns, last modified), or omit to list all. Da...

Get the SQL query behind a workbook element. Returns the compiled SQL that Sigma generates for tables, charts, and pivot tables. Use for debugging dat...

Get files in your Sigma organization. Pass file_id (inode ID) for a single file's details, or omit to list all files. Files include workbooks, dataset...

Get permission grants in your Sigma organization. Pass grant_id for a single grant's details. Otherwise you MUST provide at least one filter: inode_id...

Get members in your Sigma organization. Pass member_id for a single member's details (name, email, role, teams), or omit to list all members. Use to a...

Get reports in your Sigma organization. Pass report_id for a single report's details, or omit to list all. Reports are read-only snapshots of workbook...

List all scheduled exports for a report. Returns schedule IDs, recurrence, target destinations, and status.

Get teams in your Sigma organization. Pass team_id for a single team's details (members, user attributes), or omit to list all teams. Teams control ac...

Get templates in your Sigma organization. Pass template_id for a single template's details and source info, or omit to list all. Templates are reusabl...

List all scheduled exports for a workbook. Returns schedule IDs, recurrence, target destinations (email, Slack, webhook, cloud storage), and status. U...

Get elements (tables, charts, pivot tables, controls, text) in a workbook. Omit element_id to list all elements with their types and names. Pass eleme...

Get the data lineage for a workbook. Shows the full dependency graph: which connections, databases, schemas, tables, and datasets feed into this workb...

Get the pages in a workbook. Returns page IDs, names, and order. Use this to understand workbook structure before drilling into individual page elemen...

List all SQL queries in a workbook. Returns every query that Sigma generates across all elements and pages. Use for a full overview of the SQL a workb...

Get workbooks in your Sigma organization. Pass workbook_id for a single workbook's full details (owner, pages, last modified, version history URL), or...

Get workspaces in your Sigma organization. Pass workspace_id for a single workspace's details and grants, or omit to list all. Workspaces are folders ...

Send a report via email to one or more recipients. The report is exported in the specified format and attached to the email.

Send a workbook to one or more email addresses. The workbook is rendered in the specified format (PDF, CSV, XLSX, PNG) and delivered as an attachment....

Test whether a data connection is working. Returns connectivity status and any error details. Use after setting up a connection or when debugging data...

Create or update a permission grant on a Sigma resource. Specify the resource (inode_id), the permission level, and who to grant it to (member_id or t...

Create or update a Sigma member. To create: provide email, first_name, last_name, and member_type. To update: provide member_id plus fields to change ...

Create or update a scheduled export for a report. To create: provide report_id, cron_expression, export_format, and targets. To update: provide report...

Create or update a Sigma team. To create: provide name (required), optionally description, visibility, members, create_team_folder. To update: provide...

Create or update a scheduled export for a workbook. To create: provide workbook_id, cron_expression, export_format, and targets. To update: provide wo...

Create a new Sigma workbook. Requires folder_id (destination folder) and name. The workbook starts empty — add data elements by connecting to a data s...

Create or update a Sigma workspace. To create: provide name (required). Set no_duplicates=true to prevent duplicate names. To update: provide workspac...