The following article covers Sigma’s developer API for workbooks.
Workbook exporting is covered in Workbook Export API. Workbook schemas are covered in Workbook Schema API

Summary of Content

Endpoints
The Workbook Object
      Attributes
The Workbook List Object
      Attributes
List Workbooks
      Permissions 
      Parameters
      cURL Request
      Response
Look up a Workbook
      Permissions
      Parameters
      cURL Request
      Response
      Example
Related Resources

Endpoints

GET /v2/workbooks

      Returns a list of available workbooks. Learn more.
      Try it in Swagger

GET /v2/workbooks/{workbookId}

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

      Try it in Swagger

The Workbook Object

Attributes

workbookId string

The workbook’s unique identifier.

createdBy string

The unique identifier, memberId, of the organization member who created the workbook.

updatedBy string

The unique identifier, memberId, of the organization member who last modified changes to the workbook.

createdAt string

The timestamp at which the workbook was created.

updatedAt string

The timestamp at which the workbook was last modified.

name string

The workbook name.

url boolean

The URL path to the workbook.

IsArchived boolean | undefined

True if the workbook has been archived.

{
   "workbookId": "dbaf643d-cba5-40c0-b0f5-6bc529659ab5",
   "createdBy": "8C2szXPJqLXpIevcD5adESnwfPUpp",
   "updatedBy": "8C2szXPJqLXpIezcD5adESnwfPUpp",
   "createdAt": "2021-10-04T20:36:40.960Z",
   "updatedAt": "2021-10-11T18:38:16.978Z",
   "name": "Plugs Electronics Sales Performance",
   "url": "https://app.sigmacomputing.com/my-org/b/6Rrtndc3aWx7T30cWvLEAW"
}

 

The Workbook List Object

Attributes

entries Array<Workbook>

A list of workbooks matching the requested parameters.

Default number of entries per page: 50

 

hasMore boolean

True if additional workbooks are available (accessible but not included in the current list).

 

total number

That total number of available workbooks, including those on other pages.

Workbooks in the organization that are not accessible by the user are excluded from this count.

 

nextPage string | null

The next page in the list of workbooks. Used for pagination.

{
"entries": [
     <Workbook>,
    <Workbook>,
    ...
 ],
  "hasMore": true,
  "total": 63,
  "nextPage": "50"
}

 

List Workbooks

Returns a list of available workbooks.

GET /v2/workbooks

Try it in Swagger

Permissions 

  • You will only  have access to the workbooks available in Sigma to the user account associated with the API access token.
    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

page string [optional]

An identifier used for pagination. 

limit number [optional]

The number of workbooks to be returned. 

cURL Request

curl --location --request GET 'https://api.sigmacomputing.com/v2/workbooks?page={page}&limit={limit} \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns Array<Workbook>.

{
"entries": [
     <Workbook>,
    <Workbook>,
    ...
 ],
  "hasMore": boolean,
  "total": number,
"nextPage": string | null
  }

 

Example

Example Request:

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

 

Example Response:

{
 "entries": [
   {
      "workbookId": "dbaf643d-cba5-40c0-b0f5-6bc529659ab5",
      "createdBy": "8C2szXPJqLXpIevcD5adESnwfPUpp",
      "updatedBy": "8C2szXPJqLXpIezcD5adESnwfPUpp",
      "createdAt": "2021-10-04T20:36:40.960Z",
      "updatedAt": "2021-10-11T18:38:16.978Z",
      "name": "Plugs Electronics Sales Performance",
      "url": "https://app.sigmacomputing.com/my-org/b/6Rrtndc3aWx7T30cWvLEAW"
   },
   {
     "workbookId": "9551t76d-23f7-4195-ad98-d9d2578c7d05",
      "createdBy": "8C2szXPJqLXpIevcD5adESnwfPUpp",
      "updatedBy": "6VZpXc5Pl6XpIezcD5adtYi23Pt1u",
      "createdAt": "2021-10-04T21:14:25.963Z",
      "updatedAt": "2021-10-07T21:01:40.848Z",
      "name": "Sales by Product Group",
      "url": "https://app.sigmacomputing.com/my-org/b/4xLe1KDR78M9cmYkgYJrtX",
     "isArchived": true
   },
   ...
 ],
  "hasMore": false,
  "total": 2,
 "nextPage": null
}

 

Look up a Workbook

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

GET /v2/workbooks/{workbookId}

Try it in Swagger

 

Permissions 

  • You will only  have access to the workbooks available in Sigma to the user account associated with the API access token.
    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

None 

cURL Request

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

 

Response

Returns a workbook object.

{
   "workbookId": string,
   "createdBy": string,
   "updatedBy": string,
   "createdAt": string,
   "updatedAt": string,
   "name": string,
   "url": string,
   "isArchived": boolean
}

 

Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/workbooks/9551t76d-23f7-4195-ad98-d9d2578c7d05' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Example Response:

{
  "workbookId": "9551t76d-23f7-4195-ad98-d9d2578c7d05",
   "createdBy": "8C2szXPJqLXpIevcD5adESnwfPUpp",
   "updatedBy": "6VZpXc5Pl6XpIezcD5adtYi23Pt1u",
   "createdAt": "2021-10-04T21:14:25.963Z",
   "updatedAt": "2021-10-07T21:01:40.848Z",
   "name": "Sales by Product Group",
   "url": "https://app.sigmacomputing.com/my-org/b/4xLe1KDR78M9cmYkgYJrtX",
  "isArchived": true
}

 

Related Resources

API Documentation

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

Product Documentation

Workbooks: An Overview