Many of Sigma’s API endpoints require a unique identifier (id) for a target object (e.g. organizationId, connectionId, workbookId). This article will point you to where you can find these IDs based on the object type.
 

Summary of Content

Requirements
Find your Organization’s ID
Find a Connection ID
Find a Dataset ID
Find a Workbook ID
Find a Workbook Element ID
Find a Member ID
Find a Team ID
Related Resources

Requirements

  • Organization and member IDs can only be accessed through Sigma’s API. A user must authenticate with the API. The authenticated user must also have permission to access the requested data.
  • All other IDs can be accessed when logged into the Sigma application. The logged in user must also have permission to access the object.

Find Your Organization’s ID

In Sigma

An organization ID can't be identified directly from the Sigma application.

In the API

When using Sigma’s API, the organization that the current authenticated user belongs to can be identified using the API’s WhoAmI endpoint.

Find a Connection ID

In Sigma

A connection id can be identified from the individual connection’s page in Sigma. This is only accessible to organization members with access to the entire connection. 

To look up the long version of the connectionId:

  1. Open your Sigma Admin Portal.

  2. In the left panel, click Connections.
  3. Select the connection you would like to view.

  4. The connectionId will be included in the URL.

    The connection name and id are separated by a dash (-).
    Structure:

    https://app.sigmacomputing.com/<company-url>/s/<connection-name>-<connection-id>

    Example:

    https://app.sigmacomputing.com/my-company/s/Connection-Root-1f8e9847-c7o5-41Te-93b0-b80bPyyf9730

    Important: This gets the long version of the UUID. Use this version when calling Connection API and Connection Grants API endpoints.

To look up the short version of the connectionId:

  1. Open your Sigma home page.
  2. Select a connection from the left navigation panel.
  3. This will open the connection page.
  4. The connection ID will be included in the URL.
    The connection name and ID are separated by a dash (-).
    Structure:
    https://app.sigmacomputing.com/<company-url>/s/<connection-name>-<connection-id>
    Example:
    https://app.sigmacomputing.com/my-company/s/Connection-Root-mtVQZuY2C78qStSyBE64y

In the API

A complete list of connections, including their ids, can be accessed from the dataset endpoint.

Note: The API returns the long version of the UUID.

Find a Workspace ID

In Sigma

A workspace ID can be identified from the individual workspace's page in Sigma. This is only accessible to organization members with access to the entire workspace. To look up the workspaceId:

  1. Open your Sigma home page.

  2. Click Workspaces.
  3. Find the workspace you're looking for in the list.

  4. Click the workspaces vertical ••• menu. Then click Open.

  5. The workspace id will be included in the URL.

    The workspace name and id are separated by a dash (-).
    Structure:

    https://app.sigmacomputing.com/<company-url>/s/<workspace-name>-<workspace-id>

    Example:

    https://app.sigmacomputing.com/my-company/s/eng-team-1mS1ndDmvcE7MivbcCVbhv

    Note: This gets the short version of the UUID.

In the API

A complete list of workspaces, including their IDs, can be accessed from the dataset endpoint.
Note: The API returns the long version of the UUID. Both short and long versions can be used when calling an endpoint.

Find a Dataset ID

In Sigma

A dataset id can be identified from the individual dataset’s page in Sigma. To look up a dataset Id:

  1. Open the dataset.
  2. The dataset ID will be included in the URL.
    Structure:
    https://app.sigmacomputing.com/<company-url>/b/<dataset-name>-<dataset-id>/...
    Example:
    https://app.sigmacomputing.com/my-company/b/Salesforce-Campaigns-23PiCBrgchwHc3g323Ai

In the API

A complete list of datasets, including their IDs, can be accessed from the dataset endpoint.

Find a Workbook ID

In Sigma

A workbook ID can be identified from the individual dataset’s page in Sigma. To look up a workbook ID:

  1. Open the workbook.
  2. The workbook id will be included in the URL.
    Structure:
    https://app.sigmacomputing.com/<company-url>/workbook/<workbook-name>-<workbook-id>/...
    Example:
    https://app.sigmacomputing.com/my-company/workbook/My-Workbook-7sYWojYnccxJqdqkNKAw6S?:draftId=72c0acd6-4803-4766-b322-7dd05c4a445d

In the API

A complete list of datasets, including their IDs, can be accessed from the workbook endpoint.

Find a Workbook Element ID

In Sigma

A workbook element’s ID can be identified when the workbook is open and the element is selected. To look up a workbook element ID:

  1. Open the workbook.
  2. Click to select the element. 
  3. The element id will be included in the URL as an “inodeId.”
    Structure:
    https://app.sigmacomputing.com/<company-url>/workbook/<workbook-name>-<workbook-id>?:nodeId=<element-id>
    Example:
    https://app.sigmacomputing.com/my-company/workbook/My-Workbook-7sYWojYnccxJqdqkNKAw6S?:nodeId=Mkaex5leIGcjlkQa5PqEw

 

In the API

Workbook element ids can be found nested within in a success response from the workbook schema endpoint

Find a Member ID

In Sigma

Member IDs cannot be identified directly from the Sigma application.

In the API

When using Sigma’s API, the memberId belonging to the current authenticated user can be identified using the API’s WhoAmI endpoint. A complete list of organization members, including their IDs, can be accessed from the members endpoint.

Find a Team ID

In Sigma

A team id can be identified in Sigma via the Admin Portal. This is only accessible to organization members with team administration permissions. To look up a team ID:

  1. Open the Admin Portal.
  2. Select the Teams Page from the left panel.
  3. Click a team in the list to select it.
  4. The team ID is included in the URL.
    Structure:
    https://app.sigmacomputing.com/<company-url>/admin/teams/<team-id>
    Example:
    https://app.sigmacomputing.com/my-company/admin/teams/87659652-5289-4225-95cQ-4b75T3268bEn

In the API

A complete list of teams, including their IDs, can be accessed from the team endpoint.

 

Related Resources

Get Started with Sigma's API