For AI agents: visit https://help.sigmacomputing.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Sigma Computing
DocumentationAPI RecipesAPI ReferenceWhat's New
HomeCommunityQuickStartsStatusSigma Computing
Documentation
HomeCommunityQuickStartsStatus
DocumentationAPI RecipesAPI ReferenceWhat's New

Start

  • About Sigma
    • Sigma basics
    • Get around in Sigma
    • About billable usage events
  • Start using Sigma
    • Sigma's sample connection
    • Sigma Public
    • Sigma templates
      • Get started with workbook templates
      • HubSpot Campaign Analysis template
      • Snowflake usage templates
    • Get started with AI in Sigma

Tutorials

  • Learn Sigma
  • Sigma Fundamentals for Builders
    • Lesson one: Basic organization and navigation
    • Lesson two: Working with data tables
    • Lesson three: Grouped tables and pivot tables
    • Lesson four: Charts and visualizations
    • Lesson five: Controls and actions
    • Lesson six: Organization
    • Lesson seven: Style
    • Lesson eight: Input tables and combining data

Connect

  • Connect to data sources
    • Snowflake
      • Connect to Snowflake
      • Connect to Snowflake with OAuth
      • Set up a Snowflake connection for Python
      • Specify session variables for a Snowflake connection (Beta)
      • Restore input table access for a Snowflake connection or user
    • Databricks
      • Connect to Databricks
      • Connect to Databricks with OAuth
      • Set up a Databricks connection for Python
    • Redshift
      • Connect to Redshift
    • BigQuery
      • Connect to BigQuery
      • Connect to BigQuery with OAuth (Beta)
    • AlloyDB
      • Connect to AlloyDB
    • MySQL
      • Connect to MySQL
    • PostgreSQL
      • Connect to PostgreSQL
    • Starburst
      • Connect to Starburst
    • Azure SQL Database
      • Connect to Azure SQL Database
    • SQL Server 2022 and Azure SQL Managed Instance
      • Connect to SQL Server 2022 and Azure SQL Managed Instance
  • Manage connections
    • Set up write access
    • About OAuth with write access
      • Run a workbook with service account credentials
    • Dynamically assign roles used by a connection
    • Connect through SSH
    • Set up Private Link
      • AWS PrivateLink Connections
      • Azure Private Link Connections
      • GCP Private Service Connect
    • Troubleshoot your connection
    • Troubleshoot input table connection issues

Model

  • Get started with data modeling
    • Tutorial: Intro to data models
    • Data modeling best practices
  • Data models
    • Create and manage data models
    • Manage AI context for a data model (Beta)
    • Navigate data models
    • Define relationships in data models
    • Validate content in a data model
  • About metrics
    • Create and manage metrics
  • Review and manage your data catalog
  • Migrate a dataset to a data model
  • Add and manage data
    • Supported data types and formats
    • Upload CSV data
  • Join and union data
    • Overview of joining data
    • Create and edit joins in data models and workbooks
    • Create and edit unions
  • Transform data
    • Define custom datetime formats
    • Generate and access structured objects
  • Data security
    • Set up row-level security
    • Configure column-level security

Analyze

  • Workbook basics
    • Workbooks overview
    • Workbook modes overview
    • Navigate a workbook
    • Collaborate with Live Edit in workbooks
    • Intro to Element Types
  • Build a workbook
    • Create a workbook
    • Ad hoc data explorations
    • Use your organization's plugins
    • Draft and publish a workbook
    • Copy workbook pages
    • Copy and paste workbook elements
    • Design workbook layouts
  • Data elements
    • Create a data element
    • Use related columns in a workbook or data model
    • Use linked columns in workbooks
    • Add columns through Lookup
    • Create and edit period-over-period analysis
    • Organize columns into folders
  • Tables
    • Create and manage tables
    • Format and customize a table
    • Add hyperlinks and images to columns
    • Extract columns from JSON or variant data
    • Pivot tables
      • Working with pivot tables
      • Pivot table totals and subtotals
      • Format pivot table totals
      • Work with hierarchies (Beta)
      • Create ad hoc calculations
    • Transpose a table
  • Write code
    • Write and run Python code in Sigma
    • Python method reference
  • Query
    • Write custom SQL
    • Reference workbook control values in SQL statements
    • Query a dbt Semantic Layer integration
    • Query and extend Snowflake semantic views in Sigma (Beta)

Manage Workbooks

  • Manage a workbook
    • View workbook and data model data lineage
    • Change the data source for a workbook, data model, or element
    • Manage workbook refresh options
    • Manage workbook localization
    • Add shortcuts to documents
    • Manage workbook pages
      • Workbook page settings overview
      • Manage workbook page visibility
      • Add custom page panels to a workbook
  • Document templates
    • Create documents from templates
    • Create and edit document templates
  • Workbook lifecycle
    • Workbook lifecycle: explore, draft, and publish
    • Add context with a document description
    • View and manage document badges
    • Workbook versions and version history
    • Add version tags to workbooks, data models, and reports
    • Use warehouse views with version tagging
    • Use input tables with version tagging
  • Workbook performance
    • Best practices for improved document performance
    • About materialization
      • Schedule materialization for a data model or workbook (Beta)
      • Schedule materialization for a version-tagged data model
    • Caching and data freshness
    • Set a query ID cache duration
    • Configure data loading (Beta)
    • Create and manage warehouse views
  • Manage queries
    • Examine workbook and data model queries
    • Override the Snowflake warehouse used by a workbook

Chart

  • Intro to charts
  • Build a chart
    • Build a bar chart
    • Build a line chart
    • Build a KPI chart
    • Build a scatter plot
    • Build a Sankey diagram
    • Build a funnel chart
    • Build a gauge chart
    • Build a geography map
    • Build a waterfall chart
    • Area charts
    • Combo charts
    • Box and whisker charts
    • Pie and donut charts
    • Maps
    • Create sparklines in a table
  • Customize a chart
    • Customize chart background and style
    • Create and format trellis charts
    • Customize chart mark tooltip fields
    • Format chart legend
    • Display chart data labels
    • Format chart axis position
    • Configure chart axis marks
    • Customize chart axis range
    • Display chart reference marks
    • Add trend lines
    • Add a custom color scale

Filter

  • Filter data
    • Dynamically filter and modify data in Sigma
    • Filter data in data elements
      • Sort filter and control values
  • Intro to control elements
    • Create and manage a control element
    • Create and configure a segmented control
    • Drill down control
    • Top N filter
    • Create and configure a legend control
    • Create and configure a file upload control (Beta)
  • Work with controls
    • Reference control values as parameters
    • Set control values in a URL using query string parameters
    • Synced controls

Design

  • UI elements
    • Intro to UI elements
    • Button elements
    • Image elements
    • Text elements
    • Value lists
  • Workbook formatting
    • Workbook settings overview
    • General element formatting
      • Customize element title
      • Customize element background and styles
    • Customize the sort order of data elements
    • Limit displayed values in a data element

Build apps

  • About Sigma AI apps
    • App tutorial: Build an employee feedback survey
  • Add or collect data
    • Intro to input tables
    • Create new input tables
    • Edit input table data
    • Configure single-select or multi-select columns in input tables
    • Configure file columns in input tables (Beta)
    • Configure data governance options for input tables
      • Apply data validation to input table columns
      • Change the data entry permission on input tables
      • Add system-generated columns to input tables
    • View input table audit history
  • Design layouts
    • Intro to layout elements
    • Use containers to organize workbook layouts
    • Use tabbed containers to organize workbook content
    • Use single row containers to show records in detail
    • Use repeated containers to generate layouts from data
    • Use modals to create focused content views
    • Use popovers to simplify a workbook interface
    • Use the navigation element to guide user exploration
    • Use forms to streamline user data entry
  • Add logic and interactivity
    • Intro to actions
    • Create actions
      • Create actions that navigate to destinations
      • Create actions that manage control values
      • Create actions that modify or refresh elements
      • Create actions that control modals and tabbed containers
      • Create actions that control single row containers
      • Create actions that modify input table data
      • Create actions that modify forms
      • Create actions that send notifications and export data
      • Create actions that generate embed iframe events
      • Create actions that modify plugins
      • Create actions that call stored procedures
      • Create actions that call API endpoints
    • Configure actions
      • Create and manage action sequences
      • Define an action condition
      • Run action sequences automatically (Beta)
      • Use variables in actions
      • Create cross-element filters
      • Create custom context menu actions
      • Build if/else control flow in an action sequence
      • View and manage existing actions

Build reports

  • Reports overview
  • Tutorial: Build and export a sales report
  • Build and customize reports
    • Create and edit reports
    • Add elements and data to a report
    • Customize element size, layering, and alignment in reports
    • Edit report page setup, headers, and footers
    • Edit report page order, visibility, and numbers
    • Customize text typeface, size, and style in reports
    • Customize report settings and themes
  • Share and export reports

Interact

  • Ask questions of data with AI
    • Ask natural language queries with Sigma Assistant
    • Ask a question about a data source table
  • Interact with AI tools
    • Use the Sigma MCP Server
    • Install skills for AI assistants
  • Interact with workbooks
    • Create and interact with custom views
    • Create and share saved views
    • View column details
    • Find a specific value in a table or input table (Beta)
    • Choose your Snowflake role for an OAuth connection (Beta)
    • Keyboard shortcuts: Mac OS
    • Keyboard shortcuts: Microsoft Windows
  • Interact with charts
    • Drill down into data
    • View underlying data
    • Explain charts with AI
    • Highlight chart values
  • Collaborate in workbooks
    • Use comments in workbooks
    • Capture and annotate images in comments
  • Search for content in your organization
  • Manage authentication
    • Set up an app for two-factor authentication
    • Refresh your connection sign-in sessions

Share

  • Share a workbook, data model, or report
  • Share a folder
  • Share templates
    • Share document templates
    • Share and accept cross-org document templates
  • Send or schedule workbook exports
  • Export data
    • Schedule a conditional export or alert
    • Download workbook data
    • Export to email
      • Format an email message
    • Export to Slack
      • Format a Slack message
    • Export to Google Sheets
    • Export to Google Drive
    • Export to cloud storage
    • Export to webhook
    • Export as email burst
    • Export to Microsoft Teams
      • Format a Microsoft Teams message
    • Export to Microsoft SharePoint
  • Manage scheduled exports
    • Configure additional options for exports
    • Manage scheduled exports
  • About exporting data
    • Download and export limitations

Calculate

  • Functions
    • Function index
    • Aggregate functions
      • ArrayAgg
      • ArrayAggDistinct
      • Avg
      • AvgIf
      • Corr
      • Count
      • CountDistinct
      • CountDistinctIf
      • CountIf
      • GrandTotal
      • ListAgg
      • ListAggDistinct
      • Max
      • MaxIf
      • Median
      • Min
      • MinIf
      • PercentileCont
      • PercentileDisc
      • PercentOfTotal
      • RegressionIntercept
      • RegressionR2
      • RegressionSlope
      • StdDev
      • Subtotal
      • Sum
      • SumIf
      • SumProduct
      • Variance
      • VariancePop
    • Array functions
      • Array
      • ArrayCompact
      • ArrayConcat
      • ArrayContains
      • ArrayDistinct
      • ArrayExcept
      • ArrayIntersection
      • ArrayJoin
      • ArrayLength
      • ArraySlice
      • RaggedHierarchy (Beta)
      • Sequence
      • SplitToArray
      • Sparkline
      • SparklineAgg
    • Date functions
      • ConvertTimezone
      • DateAdd
      • DateDiff
      • DateFormat
      • DateFromUnix
      • DateFromUnixMs
      • DateFromUnixUs
      • DateLookback
      • DatePart
      • DateParse
      • DateTrunc
      • Day
      • DayOfYear
      • EndOfMonth
      • Hour
      • InDateRange
      • InPriorDateRange
      • LastDay
      • MakeDate
      • Minute
      • Month
      • MonthName
      • Now
      • Quarter
      • Second
      • Today
      • Weekday
      • WeekdayName
      • Year
    • Financial functions
      • CAGR
      • Effect
      • FV
      • IPmt
      • Nominal
      • NPer
      • Pmt
      • PPmt
      • PV
      • XNPV
    • Geography functions
      • Area
      • Centroid
      • Distance
      • Geography
      • Intersects
      • Latitude
      • Longitude
      • MakeLine
      • MakePoint
      • Perimeter
      • Within
    • Join functions
      • Lookup
      • Rollup
    • Logical functions
      • Between
      • Choose
      • Coalesce
      • If
      • In
      • IsNotNull
      • IsNull
      • Switch
      • Zn
      • NullIf
    • Math functions
      • Abs
      • Acos
      • Asin
      • Atan
      • Atan2
      • BinFixed
      • BinRange
      • BitAnd
      • BitOr
      • Ceiling
      • Cos
      • Cot
      • Degrees
      • DistanceGlobe
      • DistancePlane
      • Div
      • Exp
      • Floor
      • Greatest
      • GreatestNonNull
      • Int
      • IsEven
      • IsOdd
      • Least
      • LeastNonNull
      • Ln
      • Log
      • Mod
      • MRound
      • Pi
      • Power
      • Radians
      • Round
      • RoundDown
      • RoundUp
      • RowAvg
      • Sign
      • Sin
      • Sqrt
      • Tan
      • Trunc
    • Passthrough functions
      • AggDatetime
      • AggGeography
      • AggLogical
      • AggNumber
      • AggText
      • AggVariant
      • CallDatetime
      • CallGeography
      • CallLogical
      • CallNumber
      • CallText
      • CallVariant
    • System functions
      • CurrentTimezone
      • CurrentUserAttributeText
      • CurrentUserEmail
      • CurrentUserFirstName
      • CurrentUserFullName
      • CurrentUserInTeam
    • Text functions
      • Concat
      • Contains
      • EndsWith
      • Find
      • ILike
      • Left
      • Len
      • Like
      • LPad
      • Lower
      • LTrim
      • MD5
      • Mid
      • Proper
      • RegexpCount
      • RegexpExtract
      • RegexpMatch
      • RegexpReplace
      • Repeat
      • Replace
      • Reverse
      • Right
      • RPad
      • RTrim
      • SHA256
      • SplitPart
      • StartsWith
      • Substring
      • Trim
      • Upper
      • UrlPart
    • Type functions
      • Date
      • Json
      • Logical
      • Number
      • Text
      • Variant
    • Window functions
      • CumulativeAvg
      • CumulativeCorr
      • CumulativeCount
      • CumeDist
      • CumulativeMax
      • CumulativeMin
      • CumulativeStdDev
      • CumulativeSum
      • CumulativeVariance
      • FillDown
      • First
      • FirstNonNull
      • Lag
      • Last
      • LastNonNull
      • Lead
      • MovingAvg
      • MovingCorr
      • MovingCount
      • MovingMax
      • MovingMin
      • MovingStddev
      • MovingSum
      • MovingVariance
      • Nth
      • Ntile
      • Rank
      • RankDense
      • RankPercentile
      • RowNumber
      • VisibilityLimit
  • Operators overview
  • Use AI with formulas
  • Perform AI queries
  • Metrics
    • Use metrics in a workbook
  • Custom functions
    • Create reusable custom functions

EMBED

  • Intro to embedded analytics
    • Migrate to JWT-signed secure embed URLs
  • Public embedding
    • Create and manage a public embed
  • Secure embedding
    • Create a secure embed
    • Generate embed client credentials
    • Manage access to a secure embed
    • Create an embed API with JSON Web Tokens
    • JSON web token claims reference
    • Embed URL parameters
    • URL encoding reference for parameters
    • Test an embed URL in the embed sandbox
    • Common embed error codes and messages
  • Advanced data security in embeds
    • Restrict access to data in embedded content
    • Embed Sigma Assistant
  • Additional embedding configurations
    • Implement inbound and outbound events in embeds
      • Inbound event reference
      • Outbound event reference
    • Manage iframes for embeds
    • Configure a shareable link for an embed
  • Embed SDK for React
  • Sigma Tenants (Beta)
    • Create and manage tenant organizations (Beta)
    • Deploy content to tenant organizations (Beta)
      • Sigma Tenants deployment use cases and examples (Beta)
      • Deploy content from one tenant organization to one or more tenants (Beta)
      • Deploy content from a parent organization to one or more tenants (Beta)
      • Manage content deployed in tenant organizations (Beta)
      • Embed content from a tenant organization (Beta)

Develop

  • Sigma API
    • About the Sigma REST API
  • Plugin development
    • Get started with custom plugins
    • Develop plugins for Sigma
    • Plugin development API
    • Plugin examples
    • Configure plugins to work with actions

Build from code

  • Manage data models as code
    • Get the code representation of a data model
    • Create a data model from a code representation
    • Update a data model from a code representation
    • Specify column order in the code representation of a data model
    • Sort data in the code representation of a data model
    • Format columns and metrics in the code representation of a data model
  • Data model representation example library
    • 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 metric timeline
    • 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 filters
    • Example representation: Data model with a join
    • Example representation: Data model with a union
    • Example representation: Data model with a transposed table
    • Example representation: Data model with column-level security
    • 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

Admin

  • Administer Sigma
  • Users and teams
    • Invite new users to your organization
    • Manage Users with User 360
    • Guest User Accounts
    • Impersonate users
    • Deactivate users
    • Teams
      • Create and manage teams
      • Manage team members
      • Manage team admins
      • Manage workspaces
  • Permissions
    • Data access overview
      • Manage access to data and connections
    • Folder and document access
    • Configure user attributes
    • Account type permissions
      • Account type and license overview
      • Create and manage account types
      • Basic explore vs. Full explore
      • View license utilization
      • Respond to account upgrade requests
  • Authentication
    • Authentication methods for your Sigma organization
    • Manage password authentication
    • Set up single sign-on with SAML
    • Manage users and teams with SCIM
    • Manage users and teams with SCIM and Okta
    • Use custom account types with your IdP
    • Custom Session Timeouts for Okta
    • About using OAuth with Sigma
      • Configure a Sigma OAuth application
      • Configure an OAuth application for Databricks
      • Configure OAuth authentication for your Sigma organization
    • Restrict access to Sigma by IP address
    • Set up inactivity timeouts
    • Customer-managed keys
      • Set up customer-managed keys
      • About using customer-managed keys in Sigma
    • Using multiple identity providers for your Sigma organization
  • Third-party integrations
    • Manage dbt integration
    • Configure a dbt Semantic Layer integration
    • Manage Slack integration
    • Manage Microsoft integration
  • Organization settings
    • Configure AI features for your organization
      • Configure a warehouse-hosted model as AI provider
      • Configure an external AI provider
      • Configure a usage dashboard for Sigma Assistant
      • Notice for enabling AI-enabled features in Sigma
    • Manage export frequency and authentication settings
    • Configure CSV upload and storage options
    • Enable or disable account upgrade requests
    • Enable or disable comments
    • Manage annotated image ability and storage period
    • Enable or disable public embeds
  • Customize
    • Set up custom home pages
    • Upload custom fonts
    • Create and manage workbook themes
    • Customize welcome and invite emails
    • Customize email branding
  • Localize
    • Change the account time zone
    • Manage organization locale
    • Manage organization translation files
  • Manage assets
    • Review warehouse view details
    • Manage organization schedules
    • View your organization's automated action sequences (Beta)
    • Manage materializations
    • Recover deleted documents
    • Create and manage version tags
    • Configure API credentials and connectors in Sigma
    • Tutorial: Configure API credentials, connectors, and actions for the Sigma REST API
    • Tutorial: Configure API credentials, connectors, and actions for the NYC Open Data API
  • Manage storage
    • External storage integration
      • External storage integration overview
      • Configure an external storage integration with Amazon S3
      • Configure an external storage integration with Google Cloud Storage
      • Configure an external storage integration with Azure Blob Storage
  • Audit and usage
    • Usage overview
    • Audit log
      • Enable or disable audit logging
      • Access and explore audit logs
      • Audit log events and metadata
      • Manage an audit logs storage integration
      • Export audit log data to cloud storage
  • Develop
    • Register a Plugin with your Sigma Organization
    • Register a Sigma Plugin Dev Playground

Support

  • Sigma support
    • Submit a support request
    • Escalate critical issues
    • About Sigma RADAR
    • Access Sigma documentation from AI tools
  • Sigma product releases
  • Supported regions, data platforms, and features
Powered by 

Workbook analysis

Updated 9 months ago


About Sigma
Resources
Sigma home
Blog
Learn
Sigma Community
© Sigma Computing