Sigma Computing

Sigma Computing Data models API

The Data models API from Sigma Computing — 19 operation(s) for data models.

GitHub OpenAPI

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/dataModels List the data models in my organization · List data models #
Ask an LLM
“Which data models exist in Sigma so I can spot duplicates or gaps?”
“Can I list data models without their version tag details?”
Tell an agent
List all data models I can access.
List data models, {limit} per page.
GET /v2/dataModels/{dataModelId} Get details of one data model · Get a data model #
Ask an LLM
“What are the name, owner and location of a specific data model?”
“Can I look up one data model by its ID?”
Tell an agent
Get the details of data model {dataModelId}.
Show metadata for data model {dataModelId} without tag info set to {excludeTags}.
POST /v2/dataModels/{dataModelId}:materialize Run a materialization for a data model element now · Run a scheduled materialization for a data model element #
Ask an LLM
“How do I trigger a materialization of a data model element on demand?”
“Can I refresh the cached data for one data model sheet right away?”
Tell an agent
Materialize element {sheetId} in data model {dataModelId} now.
Run the scheduled materialization for sheet {sheetId} of data model {dataModelId}.
GET /v2/dataModels/{dataModelId}/columns List columns across a data model · List columns for all elements in a data model #
Ask an LLM
“What columns exist across all elements of a data model?”
“Can I get a full column inventory for one data model?”
Tell an agent
List every column in data model {dataModelId}.
Show all data model columns for {dataModelId}, {limit} per page.
GET /v2/dataModels/{dataModelId}/elements List elements in a data model · List elements in a data model #
Ask an LLM
“Which tables and controls make up a data model?”
“Can I list data model elements as of a version tag?”
Tell an agent
List the elements of data model {dataModelId}.
Show data model {dataModelId}'s tables and controls for tag {tagName}.
GET /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules List column-level security rules on an element · List column-level security rules on a data model element (Beta) #
Ask an LLM
“Which column-level security rules protect a data model table?”
“How can I audit who can see restricted columns in a data model element?”
Tell an agent
List column security rules on element {elementId} of data model {dataModelId}.
Show the CLS rules for data model {dataModelId} element {elementId}.
POST /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules Add column-level security rules to an element · Create column-level security rules on a data model element (Beta) #
Ask an LLM
“How do I hide sensitive columns in a data model from certain users?”
“Can I create several column security rules on one element at once?”
Tell an agent
Create column security rules on element {elementId} in data model {dataModelId}.
Restrict columns on data model {dataModelId} element {elementId} with new CLS rules.
PUT /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId} Replace a column-level security rule · Update a column-level security rule on a data model element (Beta) #
Ask an LLM
“How do I change which columns an existing CLS rule covers?”
“Can I update the access criteria of a column security rule?”
Tell an agent
Update CLS rule {columnSecurityRuleId} on element {elementId} of {dataModelId} to cover {columns} with criteria {criteria}.
Replace rule {columnSecurityRuleId} in data model {dataModelId} element {elementId} using criteria {criteria} and columns {columns}.
DELETE /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId} Delete a column-level security rule · Delete a column-level security rule from a data model element (Beta) #
Ask an LLM
“How do I remove a column security rule from a data model element?”
“What happens to hidden columns when a CLS rule is deleted?”
Tell an agent destructive · confirm first
Delete CLS rule {columnSecurityRuleId} from element {elementId} in data model {dataModelId}.
Drop column security rule {columnSecurityRuleId} on {dataModelId} element {elementId}.
POST /v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules Create a materialization schedule for an element · Create a materialization schedule for a data model element (Beta) #
Ask an LLM
“How do I materialize a data model element automatically on a cron cadence?”
“Can I set up recurring caching for a data model table?”
Tell an agent
Create a materialization schedule {schedule} for element {elementId} in data model {dataModelId}.
Schedule element {elementId} of {dataModelId} to materialize on {schedule}.
PATCH /v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules Change an element's materialization cadence · Update a materialization schedule for a data model element (Beta) #
Ask an LLM
“How do I change the cron or timezone of an existing materialization schedule?”
“Can I adjust when a data model element materializes without recreating the schedule?”
Tell an agent
Change the materialization schedule of element {elementId} in {dataModelId} to {schedule}.
Update data model {dataModelId} element {elementId} to materialize on cadence {schedule}.
DELETE /v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules Delete an element's materialization schedule · Delete a materialization schedule for a data model element (Beta) #
Ask an LLM
“How do I stop scheduled materializations for a data model element?”
“Does deleting a materialization schedule cancel future runs?”
Tell an agent destructive · confirm first
Delete the materialization schedule on element {elementId} of data model {dataModelId}.
Cancel scheduled materialization runs for {dataModelId} element {elementId}.
GET /v2/dataModels/{dataModelId}/lineage Show lineage for a data model · List lineage for a data model #
Ask an LLM
“What upstream sources feed the elements of a data model?”
“Can I see the full dependency graph of a data model?”
Tell an agent
List the lineage for data model {dataModelId}.
Map data sources and upstream lineage in data model {dataModelId}.
GET /v2/dataModels/{dataModelId}/materializations/{materializationId} Check the status of a materialization job · Get a materialization job #
Ask an LLM
“Did my data model materialization job finish, and when?”
“How do I troubleshoot a materialization run that seems stuck?”
Tell an agent
Get materialization job {materializationId} for data model {dataModelId}.
Check the status of materialization {materializationId} in {dataModelId}.
GET /v2/dataModels/{dataModelId}/materializationSchedules List materialization schedules in a data model · List materialization schedules for a data model #
Ask an LLM
“Which elements in a data model are materialized on a schedule?”
“How often does each data model element get materialized?”
Tell an agent
List all materialization schedules in data model {dataModelId}.
Show every scheduled materialization for {dataModelId}.
GET /v2/dataModels/{dataModelId}/sources List the sources a data model uses · List data model sources #
Ask an LLM
“Which tables and custom SQL does a data model draw from?”
“What are the data sources behind my data model?”
Tell an agent
List the data sources of data model {dataModelId}.
Show which tables feed data model {dataModelId}.
GET /v2/dataModels/{dataModelId}/spec Export a data model as code · Get the code representation of a data model #
Ask an LLM
“How can I get a data model as a JSON or YAML representation?”
“Can I export the code of an older version of a data model?”
Tell an agent
Get the code representation of data model {dataModelId}.
Export version {documentVersion} of data model {dataModelId} as a spec.
PUT /v2/dataModels/{dataModelId}/spec Replace a data model from code · Update a data model from a code representation #
Ask an LLM
“How do I update a data model's structure programmatically from a spec?”
“Does pushing a new spec to a data model create a new version?”
Tell an agent
Replace data model {dataModelId} with a spec using schema version {schemaVersion}.
Overwrite the contents of data model {dataModelId} from my code representation.
POST /v2/dataModels/{dataModelId}/swapSources Swap connections or tables behind a data model · Swap data model sources #
Ask an LLM
“How do I move a data model from one connection to another?”
“Can I copy input table data when swapping data model sources?”
Tell an agent
Swap data model {dataModelId} to connections {connectionMapping}.
Swap the tables used by data model {dataModelId} per {sourceMapping}.
GET /v2/dataModels/{dataModelId}/tags List version tags on a data model · List tags for a data model #
Ask an LLM
“Which version tags are applied to a data model?”
“Is my data model tagged for a production release?”
Tell an agent
List the version tags on data model {dataModelId}.
Show tag information for data model {dataModelId}.
POST /v2/dataModels/spec Create a data model from code · Create a data model from a code representation #
Ask an LLM
“How do I create a brand new data model from a code definition?”
“Can I build data models programmatically and still edit them in the Sigma UI?”
Tell an agent
Create a data model named {name} in folder {folderId} from my spec.
Create data model {name} in {folderId} described as {description} from code.
POST /v2/dataModels/tag Apply a version tag to a data model · Tag a data model #
Ask an LLM
“How do I tag a data model version for release?”
“Can I set a tag as the default version of a data model?”
Tell an agent
Tag data model {dataModelId} with {tag}.
Tag version {dataModelVersion} of data model {dataModelId} as {tag}.
POST /v3alpha/dataModels/{dataModelId}:swapSources Swap data model sources (v3alpha beta) · Swap data model sources (Beta) #
Ask an LLM
“Is there a beta endpoint to swap custom SQL or data model element sources in a data model?”
“Can the v3alpha source swap replace each source of a data model individually?”
Tell an agent
Using the beta v3alpha swap, repoint data model {dataModelId} with {sourceMapping}.
Run the v3alpha source swap on {dataModelId} to replace each source via {sourceMapping}.
GET /v2/dataModels/{dataModelId}/elements/{elementId}/query Get the SQL behind a data model element · Get the SQL query for a data model element #
Ask an LLM
“How can I see the SQL a data model table generates?”
“What query does one data model element run, for a given tag?”
Tell an agent
Get the SQL for element {elementId} in data model {dataModelId}.
Show the query for data model {dataModelId} element {elementId} at tag {tagName}.

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-data-models-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing:sigma-computing-data-models-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-data-models-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Data Models API
  version: '1.0'
  description: 'Operations tagged dataModels across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sigmacomputing.com
  description: Server for GCP (US) hosted organizations
- url: https://api.sa.gcp.sigmacomputing.com
  description: Server for GCP (KSA) hosted organizations
- url: https://aws-api.sigmacomputing.com
  description: Server for AWS US (West) hosted organizations
- url: https://api.us-a.aws.sigmacomputing.com
  description: Server for AWS US (East) hosted organizations
- url: https://api.ca.aws.sigmacomputing.com
  description: Server for AWS Canada hosted organizations
- url: https://api.eu.aws.sigmacomputing.com
  description: Server for AWS Europe hosted organizations
- url: https://api.au.aws.sigmacomputing.com
  description: Server for AWS Australia and APAC hosted organizations
- url: https://api.uk.aws.sigmacomputing.com
  description: Server for AWS UK hosted organizations
- url: https://api.us.azure.sigmacomputing.com
  description: Server for Azure US hosted organizations
- url: https://api.eu.azure.sigmacomputing.com
  description: Server for Azure Europe hosted organizations
- url: https://api.ca.azure.sigmacomputing.com
  description: Server for Azure Canada hosted organizations
- url: https://api.uk.azure.sigmacomputing.com
  description: Server for Azure United Kingdom hosted organizations
- url: https://api.au.azure.sigmacomputing.com
  description: Server for Azure Australia hosted organizations
tags:


# --- truncated at 32 KB (1179 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-data-models-api-openapi.yml