Query API

The following article covers Sigma’s developer API for downloading queries. This can be used if you have a queryId from a previous call to Sigma’s workbook export endpoint.

Summary of Content

Endpoints
Download a Query Result
      Permissions
      Parameters
      cURL Request
      Response
      Example
Related Resources

Endpoints

GET /v2/query/{queryId}/download

      Downloads the result of a successful query. Learn more.
      Try it in Swagger

Download a Query Result

Downloads the result of a successful query.

GET /v2/query/{queryId}/download

Try it in Swagger

 

Permissions

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

None

cURL Request

curl --location --request GET 'https://api.sigmacomputing.com/v2/query/{queryId}/download' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

The downloaded data. The type of response varies depending on the query requested.

Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/query/{queryId}/download' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

Example Response:

The type of response varies depending on the query requested.

Related Resources

Get Started with Sigma's API
Create an API Token and Client Id
Identify Unique Ids in Sigma
Workbook Export API