Sigma’s REST API allows developers to communicate directly with Sigma. It supports actions across a broad selection of Sigma features, including:

  • Connections
  • Datasets
  • Workbooks
  • Query Downloads
  • Teams
  • Organization Members

All endpoints have resource-oriented URLs, which can be accessed over HTTP.  Endpoints accept JSON in the request body and include JSON in their response.

Account-based HTTP authentication keeps your organization’s information secure.

Summary of Content

Where do I start?
API Testing Grounds
      Swagger
      cURL
Supported Endpoints
      Connections
      Workbooks
      Datasets
      Dataset Materialization
      Queries
      Teams
      Organization Members
      Who Am I?
Related Resources

Where do I start?

Your starting point with Sigma’s API is dependent on your role, purpose, and prior knowledge of APIs. To get started, find the scenario below that best matches your current situation:

Scenario #1: I don’t know what an API is.

API stands for Application Programming Interface. APIs act as a middleman between two applications, allowing them to communicate various information.

APIs consist of endpoints for specific lines of communication–similar to how large companies have multiple phone lines that each serve a different purpose. 

Developers on your team can run code that “calls” an endpoint on Sigma’s API. Sigma will respond with the requested information or perform the requested action. 

Scenario #2: I’m an organization admin looking to get my developers up and running with Sigma’s API.

Before a developer can get started with Sigma’s API, you will need to provide them with a Client Id and API Token. These values will allow the developer to authenticate with Sigma’s API.

We highly recommend that you create a new Client Id/API Token pair for each individual developer, as API tokens are account-based, allowing you control over any given user’s access. Get started.

Scenario #3: I’m a developer who wants to get started with Sigma’s API.

If you do not already have a Client Id and API token to authenticate with Sigma’s API, please contact an organization Admin. They can use the instructions to get you set up: Get an API Token and Client Id.

Once you have these values, you’re ready to explore Sigma’s API endpoints. We recommend using either Swagger or cURL to get started.

API Testing Grounds

Both Swagger and cURL can be used as testing grounds for Sigma’s API endpoints. 

Swagger

Swagger allows you to use Sigma’s API directly from the browser.

Learn more about Sigma and Swagger or go directly to Sigma’s Swagger playground.

cURL

You may prefer to use cURL to access Sigma’s API. Example cURL requests are included throughout Sigma’s API endpoint documentation.

For authentication instructions visit Authenticating with cURL.

Supported Endpoints

Connections

POST /v2/connection/{connectionId}/lookup

      Returns the inodeId associated with the requested warehouse connection path. Learn more.

Workbooks

GET /v2/workbooks

      Returns a list of available workbooks.

GET /v2/workbooks/{workbookId}

      Returns a workbook object based on a unique workbook identifier, workbookId.

GET /v2/workbooks/{workbookId}/schema

      Returns a workbook schema object based on a workbookId.

POST /v2/workbooks/{workbookId}/export

      Returns a workbook schema object based on a workbookId.

 

Datasets

GET /v2/datasets

      Returns a list of datasets in your organization.

GET /v2/datasets/{datasetId}

      Returns a dataset object based on its unique identifier, datasetId.

Dataset Materialization

GET /v2/datasets/{datasetId}/materialization

      Returns a list of materializations for the dataset.

POST /v2/datasets/{datasetId}/materialization

      Initiates a new materialization of the specified dataset.

Queries

GET /v2/query/{queryId}/download

      Downloads the result of a successful query.

Teams

GET /v2/teams

      Returns a list of teams in your organization.

GET /v2/teams/{teamId}

      Returns a team object based on its unique identifier, teamId.

Organization Members

GET /v2/members

      Returns a list of members in your organization.

GET /v2/members/{memberId}

      Returns a member object based on its unique identifier, memberId.

Who Am I?

GET /v2/whoami

      Returns an object identifying the current authenticated user’s id and organization.

Related Resources

Get an API Token and Client Id
Authenticate with cURL
Sigma’s Swagger-based API Playground