Sigma

Connect Catalog to Sigma to sync workbooks, data sets, Data Models, and related metadata. You can use Catalog-managed credentials or run the extraction package yourself. Sigma's APIs control which objects Catalog can return. Lineage for Sigma is asset-level today.

Requirements

Before you connect Sigma to Catalog, confirm that you meet the Sigma access requirements and warehouse prerequisites in this section.

Warehouse integration required

A warehouse integration must already be configured to complete the first ingestion of this integration.

You also need the following:

• You must be an Org Admin to create a Sigma API token and Client ID, and the token must keep that access level. Extraction reads every workbook, data set, and connection of the organization, and a token that cannot reach one of them fails the run instead of skipping that asset.
• Anyone with access to an active Sigma API token and Client ID can authenticate with Sigma's API at the access level associated with the token.

What Catalog Extracts From Sigma

Extraction reads the Sigma API:

• Workbooks, with the elements they hold
• Data sets and Data Models, with the warehouse tables each one is built on
• Warehouse connections, and the folder path of every asset
• Members, who become the owners of the assets they created

Sigma objects appear in Catalog under Catalog's own names:

In Sigma	In Catalog
Workbook	Dashboard
Data set	Viz model
Data Model	Viz model

Catalog then computes lineage from warehouse tables to workbooks, through the data sets, Data Models, and element queries in between. That lineage is asset level; see Known Limitations.

Popularity comes from a different source. Sigma stamps the queries it runs on your warehouse with a signature naming the workbook and the user, and Catalog counts workbook views from those queries. Sigma assets therefore stay without popularity when your Warehouse integration does not ingest query logs.

Catalog-Managed

To get started with Sigma in Catalog, you need to be a Sigma admin and provide:

• A Sigma API token from Sigma. Treat it like any other secret credential.
• Your Client ID
• The Host URL of your instance

For more information on how to retrieve the API token and Client ID, see Get an API Token and Client ID.

To get the correct Host URL of your instance, see Identify your API request URL.

Input your credentials directly into your Catalog account in the following format:

{
    "apiToken": "*****",
    "clientId": "*****",
    "host": "https://<your_provider_url>.sigmacomputing.com"
}

Sigma API Details

For further details on the Sigma API, see Get Started with Sigma's API.

For your first sync, it will take up to 48 hours and we will let you know when it is complete.

If you are not comfortable giving us access to your credentials, continue to Client-Managed.

Client-Managed

Doing a One Shot Extract

For your trial, you can give us a one time view of your BI tool. Run the extraction package below on a machine of your own, then send us the files it writes.

Running the Extraction Package

Install the PyPI Package

pip install castor-extractor

Sigma extraction needs no optional dependency, so it needs no extra either. For further details on the Catalog Extractor PyPI package, see castor-extractor on PyPI.

Running the PyPI Package

Once the package has been installed, run the following command in your terminal:

castor-extract-sigma [arguments]

The script will run and display logs similar to:

INFO - Extracting CONNECTIONS from API
INFO - Wrote output file: /tmp/catalog/1649079699-connections.json
INFO - Extracting WORKBOOKS from API
INFO - Wrote output file: /tmp/catalog/1649079699-workbooks.json
INFO - Extracting WORKBOOK SOURCES from API
INFO - Wrote output file: /tmp/catalog/1649079699-workbook_sources.json
INFO - Extracting DATA MODELS from API
INFO - Wrote output file: /tmp/catalog/1649079699-datamodels.json

...

INFO - Extracting ELEMENTS data from API
INFO - Wrote output file: /tmp/catalog/1649079699-elements.json
INFO - Wrote output file: /tmp/catalog/1649079699-summary.json

Extraction Arguments

• -H, --host: Sigma host
• -c, --client-id: Sigma client ID
• -a, --api-token: Generated API key
• -o, --output: Directory to write to

Scheduling and Push to Catalog

When moving out of trial, you will want to refresh your Sigma content in Catalog. Here is how to do it:

The Catalog team will provide you with:

1. A Catalog Identifier we use to match your Sigma files with your Catalog instance.
2. A Catalog Token, an API token you use when uploading to Catalog.

You can then use the castor-upload command:

castor-upload [arguments]

Upload Arguments

• -k, --token: Token provided by Catalog
• -s, --source_id: Account ID provided by Catalog
• -t, --file_type: Source type to upload. Currently supported: DBT, VIZ, or WAREHOUSE

Target Files

To specify the target files, provide exactly one of the following:

• -f, --file_path: To push a single file

or

• -d, --directory_path: To push several files at once

The tool will upload every file included in the given directory. Make sure it contains only the extracted files before pushing.

Then schedule the script run and the push to Catalog using your preferred scheduler.

Known Limitations

Catalog reads Sigma metadata and lineage through Sigma's public APIs. What you see in Catalog therefore depends on what those APIs expose, their rate limits, and how Sigma models dashboards and dependencies for your tenant.

Use this section to interpret gaps that are tied to Sigma's API rather than Catalog configuration alone:

• Personal and archived content - Workbooks and data sets whose folder path runs through My Documents or Archived users are extracted but not published to Catalog.
• Field-level lineage - Column- or field-level lineage is not available for Sigma today. Use asset-level lineage to see which Sigma workbooks, data sets, and Data Models connect to warehouse tables or other Sigma assets.
• API limits - Aggressive extraction schedules or very large Sigma estates can encounter throttling responses from Sigma. Catalog retries within normal extraction runs, but a sync can take longer or need another run before every object appears.

If extraction finishes successfully and credentials are correct, missing pieces in lineage or dashboards are often consistent with Sigma's API surface rather than an error in Catalog. For how asset-level lineage differs from field-level lineage inside Catalog, see Lineage.

Sigma Data Models

Sigma Data Models are a Sigma asset type that Sigma treats as part of its semantic modeling layer so teams can reuse and govern modeled data. Catalog's Sigma connector treats Data Models as first-class Sigma assets alongside workbooks and data sets during extraction.

You'll see Data Models reflected in Catalog's Sigma visualization content the same way as other synced Sigma assets, including when you search Catalog or inspect lineage graphs that involve those models.

Setup stays the same: configure your warehouse integration, supply a valid Sigma API token, Client ID, and Host URL using Catalog-managed or client-managed extraction, then run sync on your usual cadence. You do not use a separate integration or credential block just for Data Models.

For lineage specifically:

• Expect asset-level relationships wherever Sigma's APIs describe how a Data Model connects to upstream data sets, modeled tables, or warehouse objects Catalog already knows about through your integrations.
• Column- or field-level lineage is not available for Sigma Data Models today, consistent with Known Limitations.

Together, workbook, data set, and Data Model metadata give you governance and reuse context inside Catalog at the asset level.

What's Next?

• Browse other integrations on the BI Tools overview.
• Learn how Catalog represents asset-level versus field-level lineage in Lineage.

---