cotera
Logo

Sigma Computing

Authentication Type: API Key Description: Cloud-based analytics and business intelligence platform for listing workbooks, exporting data, and managing datasets.

Authentication

To authenticate, you'll need a Sigma Computing API client ID and secret:

  1. Log in to your Sigma Computing instance as an admin
  2. Go to Administration > APIs & Embed Secrets
  3. Click Create New to generate a client ID and secret pair
  4. Your base URL depends on your cloud region (e.g., https://aws-api.sigmacomputing.com)

For more information, visit the Sigma Computing API documentation.

Workbooks

List Workbooks

List all workbooks in Sigma Computing. Returns workbook names, descriptions, and metadata.

Operation Type: Query (Read)

Parameters:

  • limit number (nullable): Maximum number of workbooks to return (default 50)

Returns:

  • entries array of objects: List of workbooks
    • workbookId string: Workbook ID
    • name string: Workbook name
    • description string (nullable): Workbook description
    • createdAt string: Creation timestamp
    • updatedAt string: Last update timestamp
    • path string (nullable): Workbook path
  • total number: Total number of workbooks

Example Usage:

{
  "limit": 50
}

Get Workbook

Get a specific Sigma workbook by ID, including its structure, pages, and elements.

Operation Type: Query (Read)

Parameters:

  • workbookId string (required): The ID of the workbook to retrieve

Returns:

  • workbookId string: Workbook ID
  • name string: Workbook name
  • description string (nullable): Workbook description
  • createdAt string: Creation timestamp
  • updatedAt string: Last update timestamp
  • path string (nullable): Workbook path
  • pages array of objects: List of pages in the workbook
    • pageId string: Page ID
    • name string: Page name
  • elements array of objects: List of elements in the workbook
    • elementId string: Element ID
    • name string: Element name
    • type string: Element type (e.g. table, chart)

Example Usage:

{
  "workbookId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Export Data

Export data from a Sigma workbook in CSV or JSON format. Triggers an async export and polls until ready.

Operation Type: Query (Read)

Parameters:

  • workbookId string (required): The ID of the workbook to export data from
  • format string (nullable): Export format: "csv" or "json" (default "csv")

Returns:

  • data string: The exported data as a string
  • format string: The format of the exported data

Example Usage:

{
  "workbookId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "format": "csv"
}

Datasets

List Datasets

List all datasets in Sigma Computing. Returns dataset names, descriptions, and metadata.

Operation Type: Query (Read)

Parameters:

  • limit number (nullable): Maximum number of datasets to return (default 50)

Returns:

  • entries array of objects: List of datasets
    • datasetId string: Dataset ID
    • name string: Dataset name
    • description string (nullable): Dataset description
    • createdAt string: Creation timestamp
    • updatedAt string: Last update timestamp
  • total number: Total number of datasets

Example Usage:

{
  "limit": 50
}

Materialize Dataset

Trigger materialization of a Sigma dataset, refreshing its cached data in the warehouse.

Operation Type: Mutation (Write)

Parameters:

  • datasetId string (required): The ID of the dataset to materialize

Returns:

  • success boolean: Whether the materialization was triggered successfully
  • datasetId string: The ID of the materialized dataset

Example Usage:

{
  "datasetId": "d1e2f3a4-b5c6-7890-abcd-ef1234567890"
}

Common Use Cases

Business Intelligence:

  • List and explore workbooks to find reports and dashboards
  • Get workbook details to understand page structure and available elements
  • Export workbook data for downstream analysis or integration

Data Management:

  • List datasets to discover available data sources
  • Trigger dataset materialization to refresh cached warehouse data
  • Export data in CSV or JSON for use in external systems

Automated Reporting:

  • Pull workbook data on a schedule for automated report generation
  • Materialize datasets before running dependent reports
  • Export and distribute data to stakeholders via downstream workflows