> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sigma-computing.md).

# Sigma Computing

Sigma Computing is a cloud analytics and business intelligence platform. Connect to read workbook metadata and pages, export element data, run materializations, and create public embed URLs.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector       | Authentication |
| --------------- | -------------- |
| Sigma Computing | Credentials    |

### Sigma Computing

Connect to Sigma Computing with API client credentials created under Administration > Developer access. Access tokens are cached in memory for their one-hour lifetime and are never persisted.

#### Set up in Sigma Computing

1. Prepare the Sigma Computing account or service that the workflow will access. Grant access to the required resources and operations.
2. **Base URL:** Your organization's Sigma API base URL, shown above your credentials in Administration > Developer access. It differs per cloud and region, e.g. <https://api.us.azure.sigmacomputing.com> (Azure US) or <https://aws-api.sigmacomputing.com> (AWS US West). Credentials only work against the region they were created in.
3. **Client ID:** Client ID of a Sigma API credential. Create one under Administration > Developer access > Create new, with the REST API scope selected. Creating credentials requires an Admin account type or the 'Create API keys' permission.
4. **Client Secret:** Client secret of the same Sigma API credential. Sigma shows it once, when the credential is created; generate a new credential if it was not saved.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Sigma Computing**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Base URL      | Optional / as applicable | Your organization's Sigma API base URL, shown above your credentials in Administration > Developer access. It differs per cloud and region, e.g. <https://api.us.azure.sigmacomputing.com> (Azure US) or <https://aws-api.sigmacomputing.com> (AWS US West). Credentials only work against the region they were created in. [Provider instructions](https://help.sigmacomputing.com/reference/get-started-sigma-api). |
| Client ID     | Yes                      | Client ID of a Sigma API credential. Create one under Administration > Developer access > Create new, with the REST API scope selected. Creating credentials requires an Admin account type or the 'Create API keys' permission. [Provider instructions](https://help.sigmacomputing.com/reference/generate-client-credentials).                                                                                      |
| Client Secret | Yes                      | Client secret of the same Sigma API credential. Sigma shows it once, when the credential is created; generate a new credential if it was not saved. [Provider instructions](https://help.sigmacomputing.com/reference/generate-client-credentials).                                                                                                                                                                   |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Sigma Computing** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Get Workbook

Look up a Sigma workbook: its name, folder, owner, last update, published version tags, and optionally the elements inside it.

#### Inputs

| Field            | Type            | Required | Description                                                                                                  |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| Workbook         | select (string) | Yes      | The workbook to look up. Options load from the selected connection.                                          |
| Include elements | boolean         | No       | Also list the workbook's tables, charts, and pivots, so a later step can pick one to export. Default: false. |

#### Outputs

| Field                   | Type          | Description                                                                                    |
| ----------------------- | ------------- | ---------------------------------------------------------------------------------------------- |
| Workbook ID             | string        | Unique ID of the workbook.                                                                     |
| Name                    | string        | Workbook name.                                                                                 |
| Description             | string        | Workbook description, when its author wrote one.                                               |
| URL                     | string        | Link to open the workbook in Sigma.                                                            |
| Folder path             | string        | Folder the workbook lives in.                                                                  |
| Latest version          | integer       | Version number of the most recent save.                                                        |
| Archived                | boolean       | Whether the workbook sits in the archive.                                                      |
| Updated at              | string        | When the workbook last changed.                                                                |
| Version tags            | array         | Published version tags on this workbook.                                                       |
| Elements                | object\_array | Tables, charts, and pivots in the workbook.                                                    |
| Number of elements      | integer       | How many elements were returned.                                                               |
| More elements available | boolean       | True when the workbook holds more elements than were returned, so the list is only part of it. |

### List Workbook Pages

List the pages (tabs) of a Sigma workbook, optionally for a published version tag. Use it to find which page holds the table or chart you want.

#### Inputs

| Field                   | Type            | Required | Description                                                                                                              |
| ----------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| Workbook                | select (string) | Yes      | The workbook whose pages you want to list. Options load from the selected connection.                                    |
| Show advanced options   | boolean         | No       | Show the version tag and limit options. Default: false.                                                                  |
| Version tag             | string          | No       | List the pages of a tagged version instead of the workbook's current state.                                              |
| Maximum pages to return | integer         | No       | Stop after this many pages. Workbooks rarely have more, and the output says when there were more to fetch. Default: 100. |

#### Outputs

| Field                | Type          | Description                                                                                     |
| -------------------- | ------------- | ----------------------------------------------------------------------------------------------- |
| Pages                | object\_array | The workbook's pages, in the order Sigma returns them.                                          |
| Number of pages      | integer       | How many pages were returned.                                                                   |
| More pages available | boolean       | True when the workbook has more pages than the limit returned, so this list is only part of it. |

### Export Workbook Element

Export a table, chart, or pivot from a Sigma workbook to CSV, Excel, or JSON, and return it as a file. Use it to attach live Sigma data to a report or to hand it to a node that reads files.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                                                                              |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workbook ID           | select (string) | Yes      | The workbook holding the element to export. It is the ID in the workbook's URL, after /workbook/. Options load from the selected connection.                                             |
| Element ID            | select (string) | Yes      | The table, chart, or pivot to export. Copy it from the element menu in Sigma (Copy element ID), or read it from the workbook's page elements. Options load from the selected connection. |
| Format                | select (string) | No       | File format for the exported data. CSV suits most reports. Available values: CSV, Excel (XLSX), JSON, JSON Lines. Default: csv.                                                          |
| Show advanced options | boolean         | No       | Show row limit, offset, control values, and file name. Default: false.                                                                                                                   |
| Row limit             | integer         | No       | Stop the export after this many rows. Leave empty for everything the element returns, up to Sigma's one-million-row ceiling.                                                             |
| Row offset            | integer         | No       | Skip this many rows before exporting. Use with the row limit.                                                                                                                            |
| Control values        | string          | No       | JSON object setting the workbook's controls before the export runs, so the file reflects a filtered view.                                                                                |
| Version tag           | string          | No       | Export a tagged version of the workbook instead of the latest saved one, so a report keeps citing the published numbers.                                                                 |
| File name             | string          | No       | Name for the exported file. Defaults to the element ID, and the format's extension is added when missing.                                                                                |

#### Outputs

| Field         | Type         | Description                                             |
| ------------- | ------------ | ------------------------------------------------------- |
| File          | binary\_file | The exported file, ready to attach or parse downstream. |
| File name     | string       | Name of the exported file.                              |
| Size in bytes | integer      | Size of the exported file.                              |
| Query ID      | string       | Sigma's ID for this export, for tracing it in Sigma.    |

### Run Materialization

Rebuild a materialized Sigma element on demand, so a workflow reads refreshed numbers instead of the last scheduled run. Optionally waits for the rebuild to finish.

#### Inputs

| Field                | Type            | Required | Description                                                                                                                                                                                    |
| -------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workbook             | select (string) | Yes      | The workbook whose materialized element you want to refresh. Options load from the selected connection.                                                                                        |
| Materialized element | select (string) | Yes      | The element to rebuild. Only elements that already have a materialization schedule appear here; add one in the workbook first if the list is empty. Options load from the selected connection. |
| Wait for completion  | boolean         | No       | Wait until the rebuild finishes before continuing, so later steps read fresh data. Turn off to start the job and move on. Default: true.                                                       |

#### Outputs

| Field              | Type    | Description                                             |
| ------------------ | ------- | ------------------------------------------------------- |
| Materialization ID | string  | Sigma's ID for this materialization job.                |
| Status             | string  | Status Sigma reported for the job.                      |
| Completed          | boolean | Whether the rebuild finished before this step returned. |
| Started at         | string  | When Sigma started the job.                             |
| Ready at           | string  | When the refreshed data became available.               |

### Create Embed URL

Create a URL that displays a Sigma workbook, page, or element in an iframe. The URL is PUBLIC: anyone with the link sees the data without signing in, so only embed content that may be shared that way. Sigma's authenticated embedding uses JWT-signed URLs instead, which this action does not create.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                 |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| Workbook        | select (string) | Yes      | The workbook to embed, or the one holding the page or element. Options load from the selected connection.                   |
| Embed           | select (string) | No       | How much of the workbook the embed shows. Available values: Whole workbook, Single page, Single element. Default: workbook. |
| Page or element | select (string) | No       | Which page or element to embed. Not needed when embedding the whole workbook. Options load from the selected connection.    |

#### Outputs

| Field       | Type   | Description                                                                                             |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------- |
| Embed URL   | string | The embed URL. It is public: anyone who has the link can view this content without signing in to Sigma. |
| Embed ID    | string | Sigma's ID for this embed, used to revoke it later.                                                     |
| Source type | string | Whether the embed shows the workbook, a page, or an element.                                            |
| Source ID   | string | The embedded page or element, when the embed is scoped to one.                                          |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sigma-computing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
