> For the complete documentation index, see [llms.txt](https://docs.euno.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.euno.ai/sources/business-intelligence/sigma-integration/sigma-integration-discovered-resources.md).

# Sigma Integration Discovered Resources

## Overview

The Sigma integration discovers the Sigma organization, its workspaces and folders, data models, workbooks, and the elements inside workbooks and data models. It discovers the following resources:

* Sigma account (`sigma_account`)
* Sigma folder (`sigma_folder`, subtypes `sigma_workspace`, `sigma_folder`)
* Sigma data model (`sigma_data_model`)
* Sigma workbook (`sigma_workbook`)
* Sigma workbook element (`sigma_workbook_element`)
* Sigma data model element (`sigma_data_model_element`)
* Data warehouse table (`table`) referenced by workbooks
* User (`user`)

Every URI is lower-cased, and characters other than letters, digits, `-`, `_`, and `.` are replaced with `_`.

## Resource hierarchy

```
Sigma account
├── Workspace (sigma_folder)
│   └── Folder (can be nested)
│       └── Workbook
│           └── Workbook element
└── Data model
    └── Data model element
```

## Sigma account (`sigma_account`)

A single resource of type `sigma_account` is observed for each configured Sigma source, representing the top-level Sigma organization.

| Property         | Type   | Description                                                                                  |
| ---------------- | ------ | -------------------------------------------------------------------------------------------- |
| `name`           | string | The organization name, or `"Sigma Account ({organization_id})"` if the name is not available |
| `type`           | string | Always `sigma_account`                                                                       |
| `subtype`        | string | Always `sigma_account`                                                                       |
| `native_id`      | string | The Sigma organization ID                                                                    |
| `external_links` | list   | List of links to open this resource in Sigma. See [External links](#external-links) below.   |

**URI pattern**

```
platform.sigma.<organization_id>
```

Example: `platform.sigma.8f2c6b1e-4a3d-4e5f-9b7a-1c2d3e4f5a6b`

## Sigma folder (`sigma_folder`)

Folders and workspaces are organizational containers in Sigma. Workspaces are top-level folders, while folders can be nested within workspaces or other folders.

| Property         | Type      | Description                                                               |
| ---------------- | --------- | ------------------------------------------------------------------------- |
| `name`           | string    | The folder or workspace name                                              |
| `type`           | string    | Always `sigma_folder`                                                     |
| `subtype`        | string    | `sigma_folder` or `sigma_workspace`                                       |
| `native_id`      | string    | The unique folder/workspace ID in Sigma                                   |
| `created_at`     | timestamp | The timestamp when the folder was created                                 |
| `updated_at`     | timestamp | The timestamp when the folder was last modified                           |
| `created_by`     | string    | The email address of the user who created the folder                      |
| `updated_by`     | string    | The email address of the user who last updated the folder                 |
| `native_owners`  | list      | The owner of the folder in Sigma                                          |
| `owner`          | string    | Derived. The first entry of `native_owners`                               |
| `external_links` | list      | Links to open the folder in Sigma. See [External links](#external-links). |

**URI pattern**

```
sigma.folder.<folder_id>
```

Example: `sigma.folder.3b1f7c2a-5d4e-4f6a-8b9c-0d1e2f3a4b5c`

## Sigma data model (`sigma_data_model`)

Data models are reusable semantic layers in Sigma that provide business-friendly views of data warehouse tables.

| Property         | Type      | Description                                                                   |
| ---------------- | --------- | ----------------------------------------------------------------------------- |
| `name`           | string    | The data model name                                                           |
| `type`           | string    | Always `sigma_data_model`                                                     |
| `subtype`        | string    | Always `sigma_data_model`                                                     |
| `native_id`      | string    | The unique data model ID in Sigma                                             |
| `created_at`     | timestamp | The timestamp when the data model was created                                 |
| `updated_at`     | timestamp | The timestamp when the data model was last modified                           |
| `created_by`     | string    | The email address of the user who created the data model                      |
| `updated_by`     | string    | The email address of the user who last updated the data model                 |
| `native_owners`  | list      | The owner of the data model in Sigma                                          |
| `owner`          | string    | Derived. The first entry of `native_owners`                                   |
| `tags`           | list      | List of version tag names associated with the data model                      |
| `external_links` | list      | Links to open the data model in Sigma. See [External links](#external-links). |

**URI pattern**

```
sigma.data_model.<data_model_url_id>
```

Example: `sigma.data_model.4hq7x2kd9mzp1rtb`

## Sigma workbook (`sigma_workbook`)

Workbooks are analytics documents in Sigma containing visualizations, tables, and analyses.

| Property                                   | Type      | Description                                                                                                          |
| ------------------------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                                     | string    | The workbook name                                                                                                    |
| `type`                                     | string    | Always `sigma_workbook`                                                                                              |
| `subtype`                                  | string    | Always `sigma_workbook`                                                                                              |
| `native_id`                                | string    | The unique workbook ID in Sigma                                                                                      |
| `description`                              | string    | The workbook description, if provided                                                                                |
| `created_at`                               | timestamp | The timestamp when the workbook was created                                                                          |
| `updated_at`                               | timestamp | The timestamp when the workbook was last modified                                                                    |
| `created_by`                               | string    | The email address of the user who created the workbook                                                               |
| `updated_by`                               | string    | The email address of the user who last updated the workbook                                                          |
| `native_owners`                            | list      | The owner of the workbook in Sigma                                                                                   |
| `owner`                                    | string    | Derived. The first entry of `native_owners`                                                                          |
| `tags`                                     | list      | List of version tag names associated with the workbook                                                               |
| `external_links`                           | list      | Links to open the workbook in Sigma. See [External links](#external-links).                                          |
| `total_read_queries_14d` / `_30d` / `_60d` | number    | When integrated with a supported warehouse, the total read queries for the timeframe are propagated to the resource. |
| `total_read_cost_14d` / `_30d` / `_60d`    | number    | When integrated with Snowflake warehouse, the total read cost for the timeframe propagated to the resource.          |
| `total_read_credits_14d` / `_30d` / `_60d` | number    | When integrated with Snowflake, the total read credits for the timeframe propagated to the resource.                 |

**URI pattern**

```
sigma.workbook.<workbook_url_id>
```

Example: `sigma.workbook.7ktn3wq8vbxe2ym5`

## Sigma workbook element (`sigma_workbook_element`)

An element within a Sigma workbook, such as a table, visualization, or calculation. Each element may contain a SQL query and can reference other elements or data warehouse tables.

| Property                                   | Type   | Description                                                                                                          |
| ------------------------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------- |
| `name`                                     | string | The element name                                                                                                     |
| `type`                                     | string | Always `sigma_workbook_element`                                                                                      |
| `subtype`                                  | string | Always `sigma_workbook_element`                                                                                      |
| `native_id`                                | string | The element ID in the format `{workbook_id}/{element_id}`                                                            |
| `raw_code`                                 | string | The SQL that Sigma generates for the element                                                                         |
| `external_links`                           | list   | Links to open the element in Sigma. See [External links](#external-links).                                           |
| `total_read_queries_14d` / `_30d` / `_60d` | number | When integrated with a supported warehouse, the total read queries for the timeframe are propagated to the resource. |
| `total_read_cost_14d` / `_30d` / `_60d`    | number | When integrated with Snowflake warehouse, the total read cost for the timeframe propagated to the resource.          |
| `total_read_credits_14d` / `_30d` / `_60d` | number | When integrated with Snowflake, the total read credits for the timeframe propagated to the resource.                 |

**URI pattern**

```
sigma.workbook.<workbook_url_id>.element.<element_id>
```

Example: `sigma.workbook.7ktn3wq8vbxe2ym5.element.a1b2c3d4e5`

## Sigma data model element (`sigma_data_model_element`)

An element within a Sigma data model. It has the same properties as a workbook element, with these differences.

| Property        | Type   | Description                                                  |
| --------------- | ------ | ------------------------------------------------------------ |
| `name`          | string | The element name                                             |
| `type`          | string | Always `sigma_data_model_element`                            |
| `subtype`       | string | Always `sigma_data_model_element`                            |
| `native_id`     | string | The element ID in the format `{data_model_uri}/{element_id}` |
| `created_by`    | string | The email address of the user who created the data model     |
| `native_owners` | list   | The owner of the parent data model                           |

**URI pattern**

```
sigma.data_model.<data_model_url_id>.element.<element_id>
```

Example: `sigma.data_model.4hq7x2kd9mzp1rtb.element.f6g7h8i9j0`

## Data warehouse table (`table`)

When a Sigma workbook references a data warehouse table, Euno links to that table. The table uses the URI of the warehouse integration that discovers it.

| Property              | Type   | Description             |
| --------------------- | ------ | ----------------------- |
| `name`                | string | The table name          |
| `type`                | string | Always `table`          |
| `database_technology` | string | The data warehouse type |
| `database_database`   | string | The database name       |
| `database_schema`     | string | The schema name         |

**URI pattern**

```
<warehouse_prefix>.<database>.<schema>.<table>
```

Example: `snowflake.acme.analytics.public.orders`

## User (`user`)

A member of the Sigma organization, identified by email.

| Property        | Type   | Description                      |
| --------------- | ------ | -------------------------------- |
| `name`          | string | The member's email address       |
| `type`          | string | Always `user`                    |
| `email_address` | string | The member's email address       |
| `label`         | string | The member's first and last name |

**URI pattern**

```
user_account.<email with @ replaced by _at_>
```

Example: `user_account.jane.doe_at_acme.com`

## Relationships

Each row is one relationship edge, written in the canonical direction for its family. Use the predicate in each heading to search for these relationships in EQL.

### Containment (`has parent` / `has child`)

| Source type                | Relationship | Target type        | Notes                                                                               |
| -------------------------- | ------------ | ------------------ | ----------------------------------------------------------------------------------- |
| `sigma_folder`             | has parent   | `sigma_account`    | Workspaces (`subtype` = `sigma_workspace`) are top-level folders under the account. |
| `sigma_folder`             | has parent   | `sigma_folder`     | Folders nested within workspaces or other folders.                                  |
| `sigma_workbook`           | has parent   | `sigma_folder`     | Workbooks belong to folders.                                                        |
| `sigma_data_model`         | has parent   | `sigma_account`    | Data models are direct children of the account.                                     |
| `sigma_workbook_element`   | has parent   | `sigma_workbook`   | Workbook elements belong to workbooks.                                              |
| `sigma_data_model_element` | has parent   | `sigma_data_model` | Data model elements belong to data models.                                          |

### Lineage (`has upstream` / `has downstream`)

| Source type                | Relationship | Target type                | Notes                                                                                                 |
| -------------------------- | ------------ | -------------------------- | ----------------------------------------------------------------------------------------------------- |
| `sigma_workbook_element`   | has upstream | `table`                    | Root elements reference warehouse tables.                                                             |
| `sigma_workbook_element`   | has upstream | `sigma_workbook_element`   | Non-root elements reference other elements.                                                           |
| `sigma_workbook_element`   | has upstream | `sigma_data_model_element` | Elements built on a data model reference its elements.                                                |
| `sigma_data_model_element` | has upstream | `table`                    | Root elements reference warehouse tables.                                                             |
| `sigma_data_model_element` | has upstream | `sigma_data_model_element` | Non-root elements reference other elements of the same data model, or elements of another data model. |

### Field-level lineage (`has upstream_fields` / `has downstream_fields`)

| Source type                | Relationship         | Target type | Notes                    |
| -------------------------- | -------------------- | ----------- | ------------------------ |
| `sigma_workbook_element`   | has upstream\_fields | `column`    | Root workbook elements   |
| `sigma_data_model_element` | has upstream\_fields | `column`    | Root data model elements |

### Usage (`is user of` / `is used by`)

| Source type | Relationship | Target type                | Notes                                                 |
| ----------- | ------------ | -------------------------- | ----------------------------------------------------- |
| `user`      | is user of   | `sigma_workbook`           | When the Sigma Impressions integration is configured. |
| `user`      | is user of   | `sigma_workbook_element`   | When the Sigma Impressions integration is configured. |
| `user`      | is user of   | `sigma_data_model`         | When the Sigma Impressions integration is configured. |
| `user`      | is user of   | `sigma_data_model_element` | When the Sigma Impressions integration is configured. |

## External links

Many Sigma resources expose an `external_links` property so API and UI consumers can offer “open in Sigma”–style actions. This property is a list of link objects. Each object has:

| Field   | Type   | Description                                                             |
| ------- | ------ | ----------------------------------------------------------------------- |
| `label` | string | Display label for the link (e.g. `"Open in Sigma"`, `"Sigma Account"`). |
| `url`   | string | URL that opens the resource in the Sigma web application.               |

**Where it appears:**

* `sigma_account`: Typically one link with label `"Sigma Account"` pointing to the organization in Sigma (e.g. `https://app.sigmacomputing.com/{organization_name}`).
* `sigma_folder`: Link with label `"Open in Sigma"` to the folder in the Sigma UI (when a URL is available).
* `sigma_data_model`: Link with label `"Open in Sigma"` to the data model.
* `sigma_workbook`: Link with label `"Open in Sigma"` to the workbook.
* `sigma_workbook_element`: Link with label `"Open in Sigma"` to the element within its workbook.
* `sigma_data_model_element`: Link with label `"Open in Sigma"` to the element within its data model.

If the Sigma API does not provide a URL for the resource, `external_links` may be an empty list.


---

# 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.euno.ai/sources/business-intelligence/sigma-integration/sigma-integration-discovered-resources.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.