The following article covers Sigma’s developer API for organizations’ data warehouse connections. 

Summary of Content

Endpoints
The Connection Inode Object
      Attributes
Look up a Connection Path
      Permissions
      Parameters
      cURL Request
      Response
      Example
Related Resources

Endpoints

POST /v2/connection/{connectionId}/lookup

      Returns the inodeId associated with the requested warehouse connection path. Learn more.
      Try it in Swagger.

The Connection Inode Object

Attributes

inodeId string

The unique identifier associated with the scope or table object belonging to the requested connection path.

kind string

The object’s type: “scope” or “table”.

url string

A direct link to the connection in Sigma.

 

{
  "kind": "scope",
  "inodeId": "48726c98-8495-4488-bb6e-108a115b732df",
  "url": "https://app.sigmacomputing.com/my-company/s/Connection-Root-4SFd7UTAvfOtR00hg9r73t"
}

 

Look up a Connection Path

Returns the inodeId associated with the requested warehouse connection path.

POST /v2/connection/{connectionId}/lookup

Try it in Swagger

Permissions 

  • The user account associated with the API access token must have access to the connection schema being requested.
    Note: If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

path array<string> [required]

The path to look up in the connection. Your path may include one or more scopes and a table.
Max array length: 3

cURL Request

curl --location --request POST 'https://api.sigmacomputing.com/v2/connection/{connectionId}/lookup' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{"path": {path}}'

 

Response

{
  "kind": "scope" | "table",
  "inodeId": string,
  "url": string
}

 

Example

Example Request:

curl --location --request POST 'https://api.sigmacomputing.com/v2/connection/48726c98-8495-4488-bb6e-108a115b732df/lookup' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{"path": [
    "plugs_electronics"// scope
    "d_product"  // table located within the above scope
]}'


Example Response:

{
  "kind": "table",
  "inodeId": "48726c98-8495-4488-bb6e-108a115b732df",
  "url": "https://app.sigmacomputing.com/my-company/t/6gwySjidOrmByoqcLetqNU"
}

 

Related Resources

API Documentation

Get Started with Sigma's API
Create an API Token and Client Id

Product Documentation

Creating a Connection