We are excited to announce the first Sigma API, which makes it easy for our customers to programmatically integrate Sigma into their existing workflows and applications. The API makes it easy to automatically put the right data in the right place at the right time to drive fast, accurate decisions across an organization. Let’s dive deeper into the API, including the specific capabilities it enables.
An Application Programming Interface (API) lets applications talk directly to each other via code to enable integration and use of their features and capabilities. With no human involvement, processes and workflows can occur automatically and quickly, manual errors are eliminated, and the full value of an application can be realized. APIs also let developers build custom functionality or features onto an existing product. APIs are typically used by developers, have capabilities around security and manageability, and also have constraints on what they can do and what information they can transfer.
Detail on the Sigma API and Endpoints
With Sigma’s new API, our customers can interact with Sigma features programmatically via code to automate workflows or integrate Sigma into other tools. Sigma analyses and data can get to the correct applications and people in the processes and workflows customers desire, resulting in faster, more accurate analysis to increase profit and realize the full value of Sigma and the data in their cloud data warehouses.
Sigma’s API includes security and authentication via API Token Keys generated by Sigma Administrators, full API documentation for developers, and a public page to help developers test and debug all the API functionality.
The API exposes specific functionality as an “endpoint” that is called on, and today includes ~15 endpoints (more to follow!) focused on taking Sigma insights or metadata and integrating them into customer workflows. These endpoints are detailed here and include the ability to:
- Return or export data from a Sigma Workbook or query
- Return Sigma metadata like a list of users, workbooks, data sets, or teams
- Perform actions like the automatic materialization of a Sigma data set in a cloud data warehouse
During the beta program for the API, its flexibility was leveraged by customers large and small in a variety of interesting ways to drive value and automation. Some examples are listed here.
API Endpoint UsedUse CaseBenefit“Fetch the results from a Sigma query”Results are exported as a CSV or PNG that then automatically gets added to a custom email for marketing partnersAbility to make “pixel-perfect” emails with relevant data for end partners“Materialize a Sigma data set”Automatically initiates Sigma data set materialization in the CDW based on completion of a data pipeline action (like an ETL batch job loading new data into the CDW)Ensures Sigma data sets always contain the most current data to drive accurate analytics“Show a specific Sigma report”Automatically schedule and send custom reports to their customersEnd customers see timely data relevant to them
Closing And Next Steps
To learn more about the API, here are a few next steps:
- We encourage you to experiment with the API if you have the need to integrate Sigma with other applications or workflows in your environment. You can learn more about the various endpoints here and can use the information on this page to test and debug the various endpoints.
- Documentation on how to configure the API, including setting up authentication, is here
- Contact our team to ask us any question or request a custom demo of how to configure the API