Jump to Content
Documentation
API Recipes
API Reference
What's New
Home
Community
QuickStarts
Status
API Reference
Home
Community
QuickStarts
Status
Documentation
API Recipes
API Reference
What's New
Example representation: Data model with a union
All
Pages
Start typing to search…
JUMP TO
GETTING STARTED
Get started with the Sigma REST API
Generate Sigma API client credentials
Identify unique IDs in Sigma
Use OAuth override tokens
Authentication
Get access token
post
Programmatic Document Control
Create and manage data models from code (Beta)
Get the JSON representation of a data model (Beta)
Create a data model from a JSON representation (Beta)
Update a data model from a JSON representation (Beta)
Specify column order in a JSON representation of a data model (Beta)
Data model representation example library (Beta)
Example representation: Data model with a single table
Example representation: Data model with a table and a calculated column
Example representation: Data model with a table and metric
Example representation: Data model with a table and relationship
Example representation: Data model with a custom SQL element
Example representation: Data model with a folder
Example representation: Data model with a grouping
Example representation: Data model with a join
Example representation: Data model with a union
Example representation: Data model with a list values control
Example representation: Data model with a text input control
Example representation: Data model with a text area control
Example representation: Data model with a number input control
Example representation: Data model with a number range control
Example representation: Data model with a date control
Example representation: Data model with a date range control
Example representation: Data model with a slider control
Example representation: Data model with a range slider control
Example representation: Data model with a segmented control
Example representation: Data model with a switch control
Example representation: Data model with a checkbox control
Example representation: Data model with a top N control
Get a JSON representation of a data model (Beta)
get
Create a data model from a JSON representation (Beta)
post
Update a data model from a JSON representation (Beta)
put
Account Types
List account types
get
List account type permissions
get
connections
List connections
get
Create a connection
post
{connectionid}
Get connection details
get
Update a connection
put
Delete a connection
del
Test a connection
get
Update a connection
patch
connection grants
List grants for a connection
get
Add grants to a connection
post
Delete a grant for a connection
del
paths
List connection paths
get
Get connection path for a table
get
Look up connections by path
post
Sync a connection by path
post
path grants
List grants for a connection path
get
Add grants to a connection path
post
Delete a grant for a connection path
del
credentials
Create API credentials
post
Delete API credentials
del
datasets
List datasets (Deprecated)
get
Get a dataset (Deprecated)
get
List dataset sources (Deprecated)
get
materialization
Materialize a dataset (Deprecated)
post
List materializations for a dataset (Deprecated)
get
grants
Get grants for a dataset (Deprecated)
get
Grant permissions on a dataset (Deprecated)
post
Delete a permission granted on a dataset (Deprecated)
del
Data Models
List data models
get
Get a data model
get
{dataModelId}
List data model sources
get
List tags for a data model
get
Tag a data model
post
List materialization schedules for a data model
get
Get a materialization job
get
Run a scheduled materialization for a data model element
post
Swap data model sources
post
List lineage for a data model
get
List elements in a data model
get
List columns for all elements in a data model
get
favorites
Get favorite documents for a user
get
Favorite a document
post
Unfavorite a document
del
files
List files
get
Create a file
post
{inodeId}
Get file information
get
Update a file
patch
Delete a file
del
grants
List grants
get
Create or update a grant
post
{grantId}
Get a grant
get
Delete a grant
del
members
List members
List members
get
List members (Paginated)
get
Create a member
post
{memberId}
Get member
get
Update member
patch
Deactivate member
del
List teams for a member
get
files
List member files
get
List recent files for a member
get
List all favorite documents of a member
get
shared templates
List templates shared with your organization
get
Accept a pending template share
post
Delete a template share
del
Share a workbook with another organization
post
tags
Get tags
get
Create a tag
post
{tagId}
Update a tag
patch
Delete a tag
del
List workbooks for a tag
get
teams
List teams
List teams
get
List teams (Paginated)
get
Create a team
post
{teamId}
Get a team
get
Update a team
patch
Delete a team
del
Get team user attributes
get
Assign user attributes to a team
post
members
List team members
get
Update team members
patch
templates
Get template
get
List templates
get
Create workbook from template
post
Swap template data sources
post
translations
List organization translation files
get
Create organization translation file
post
{lng}
Get organization translation file
get
Update organization translation file
put
Delete organization translation file
del
{lng_variant}
Get organization translation file with variant
get
Update organization translation file with variant
put
Delete organization translation file with variant
del
user attributes
List user attributes
get
Create a user attribute
post
{userAttributeId}
Get a user attribute
get
teams
Get teams for a user attribute
get
Set a user attribute for teams
post
Update a user attribute for teams
patch
Delete a user attribute for a team
del
users
Get users for a user attribute
get
Set a user attribute for users
post
Update a user attribute for users
patch
Delete a user attribute for a user
del
workbooks
List workbooks
get
Create a workbook
post
{workbookId}
Get a workbook
get
List workbook sources
get
Get version history for a workbook
get
Duplicate a workbook
post
Duplicate a tagged workbook
post
Swap workbook data sources
post
Get workbook schema
get
List SQL queries in a workbook
get
List workbook controls
get
Save a template from a workbook
post
List lineage for a workbook
get
List elements in a workbook
get
List columns for all elements in a workbook
get
bookmarks
List bookmarks in a workbook
get
Add a bookmark to a workbook
post
Get a bookmark
get
Update a workbook bookmark
patch
Delete a bookmark from a workbook
del
List bookmarks in a tagged workbook
get
Get a bookmark in a tagged workbook
get
Update a bookmark in a tagged workbook
patch
Delete a bookmark from a tagged workbook
del
Add a bookmark to a tagged workbook
post
elements
List lineage of a workbook element
get
Get the SQL query for a workbook element
get
List columns for a workbook element
get
embeds
Get embeds for a workbook
get
Create an embed for a workbook
post
Delete an embed from a workbook
del
exports
Export data from a workbook
post
Download an exported file
get
Export a workbook
post
export schedules
List scheduled exports for a workbook
List scheduled workbook exports
get
List scheduled workbook exports (Paginated)
get
Add workbook schedule
post
Update a workbook schedule
patch
Delete a scheduled export for a workbook
del
grants
Grant permissions on a workbook to users or teams
post
Delete a workbook grant
del
materializations
Get a materialization job
get
List materialization schedules for a workbook
List materialization schedules for a workbook
get
List materialization schedules for a workbook (Paginated)
get
Run a scheduled materialization for a workbook element
post
pages
List workbook pages for a workbook
get
List elements in a workbook page
get
tags
Get tags for a workbook
get
Tag a workbook
post
Remove a tag from a workbook
del
workspaces
List workspaces
List workspaces
get
List workspaces (Paginated)
get
Create a workspace
post
{workspaceId}
Get a workspace
get
Update a workspace
patch
Delete a workspace
del
grants
Grant permissions to the workspace for users or teams
post
List grants for a workspace
get
Delete a workspace grant
del
whoami
Get current user
get
Powered by
Example representation: Data model with a union
