Sigma Computing

Sigma Computing Workbooks API

The Workbooks API from Sigma Computing — 44 operation(s) for workbooks.

Documentation GitHub OpenAPI

Operations 60

GET /v2/workbooks List workbooks #

POST /v2/workbooks Create a workbook #

GET /v2/workbooks/{workbookId} Get a workbook #

GET /v2/workbooks/{workbookId}/bookmarks List bookmarks in a workbook #

POST /v2/workbooks/{workbookId}/bookmarks Add a bookmark to a workbook #

GET /v2/workbooks/{workbookId}/bookmarks/{bookmarkId} Get a bookmark #

PATCH /v2/workbooks/{workbookId}/bookmarks/{bookmarkId} Update a workbook bookmark #

DELETE /v2/workbooks/{workbookId}/bookmarks/{bookmarkId} Delete a bookmark from a workbook #

GET /v2/workbooks/{workbookId}/columns List columns for all elements in a workbook #

GET /v2/workbooks/{workbookId}/controls List workbook controls #

POST /v2/workbooks/{workbookId}/convertToReport Convert a workbook to a report #

POST /v2/workbooks/{workbookId}/copy Duplicate a workbook #

GET /v2/workbooks/{workbookId}/elements List elements in a workbook #

GET /v2/workbooks/{workbookId}/elements/{elementId}/columns List columns for a workbook element #

POST /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules Create a materialization schedule for a workbook element (Beta) #

PATCH /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules Update a materialization schedule for a workbook element (Beta) #

DELETE /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules Delete a materialization schedule for a workbook element (Beta) #

GET /v2/workbooks/{workbookId}/elements/{elementId}/query Get the SQL query for a workbook element #

GET /v2/workbooks/{workbookId}/embeds Get embeds for a workbook #

POST /v2/workbooks/{workbookId}/embeds Create an embed for a workbook #

DELETE /v2/workbooks/{workbookId}/embeds/{embedId} Delete an embed from a workbook #

POST /v2/workbooks/{workbookId}/export Export data from a workbook #

POST /v2/workbooks/{workbookId}/grants Grant permissions on a workbook to users or teams #

DELETE /v2/workbooks/{workbookId}/grants/{grantId} Delete a workbook grant #

GET /v2/workbooks/{workbookId}/lineage List lineage for a workbook #

GET /v2/workbooks/{workbookId}/lineage/elements/{elementId} List lineage of a workbook element #

GET /v2/workbooks/{workbookId}/materialization-schedules List materialization schedules for a workbook #

POST /v2/workbooks/{workbookId}/materializations Run a scheduled materialization for a workbook element #

GET /v2/workbooks/{workbookId}/materializations/{materializationId} Get a materialization job #

GET /v2/workbooks/{workbookId}/pages List workbook pages for a workbook #

GET /v2/workbooks/{workbookId}/pages/{pageId}/elements List elements in a workbook page #

GET /v2/workbooks/{workbookId}/queries List SQL queries in a workbook #

POST /v2/workbooks/{workbookId}/restoreVersion Restore a workbook to a previous version #

POST /v2/workbooks/{workbookId}/saveTemplate Save a template from a workbook #

GET /v2/workbooks/{workbookId}/schedules List scheduled workbook exports #

POST /v2/workbooks/{workbookId}/schedules Add workbook schedule #

PATCH /v2/workbooks/{workbookId}/schedules/{scheduleId} Update a workbook schedule #

DELETE /v2/workbooks/{workbookId}/schedules/{scheduleId} Delete a scheduled export for a workbook #

GET /v2/workbooks/{workbookId}/schema Get workbook schema #

POST /v2/workbooks/{workbookId}/send Export a workbook #

POST /v2/workbooks/{workbookId}/shareCrossOrg Share a workbook with another organization #

GET /v2/workbooks/{workbookId}/sources List workbook sources #

GET /v2/workbooks/{workbookId}/spec Get the code representation of a workbook (Beta) #

PUT /v2/workbooks/{workbookId}/spec Update a workbook from a code representation (Beta) #

POST /v2/workbooks/{workbookId}/swapSources Swap workbook data sources #

POST /v2/workbooks/{workbookId}/tag/{versionTag}/copy Duplicate a tagged workbook #

GET /v2/workbooks/{workbookId}/tags Get tags for a workbook #

DELETE /v2/workbooks/{workbookId}/tags/{tagId} Remove a tag from a workbook #

GET /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks List bookmarks in a tagged workbook #

POST /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/ Add a bookmark to a tagged workbook #

GET /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId} Get a bookmark in a tagged workbook #

PATCH /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId} Update a bookmark in a tagged workbook #

DELETE /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId} Delete a bookmark from a tagged workbook #

GET /v2/workbooks/{workbookId}/version-history Get version history for a workbook #

POST /v2/workbooks/spec Create a workbook from a code representation (Beta) #

POST /v2/workbooks/spec/verify Verify a workbook code representation (Beta) #

POST /v2/workbooks/tag Tag a workbook #

GET /v2.1/workbooks/{workbookId}/materialization-schedules List materialization schedules for a workbook (Paginated) #

GET /v2.1/workbooks/{workbookId}/schedules List scheduled workbook exports (Paginated) #

POST /v3alpha/workbooks/{workbookId}:swapSources Swap workbook sources (Beta) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/sigma-computing-workbooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sigma Computing Workbooks API
  version: '1.0'
  description: 'Operations tagged workbooks across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sigmacomputing.com
  description: Server for GCP (US) hosted organizations
- url: https://api.sa.gcp.sigmacomputing.com
  description: Server for GCP (KSA) hosted organizations
- url: https://aws-api.sigmacomputing.com
  description: Server for AWS US (West) hosted organizations
- url: https://api.us-a.aws.sigmacomputing.com
  description: Server for AWS US (East) hosted organizations
- url: https://api.ca.aws.sigmacomputing.com
  description: Server for AWS Canada hosted organizations
- url: https://api.eu.aws.sigmacomputing.com
  description: Server for AWS Europe hosted organizations
- url: https://api.au.aws.sigmacomputing.com
  description: Server for AWS Australia and APAC hosted organizations
- url: https://api.uk.aws.sigmacomputing.com
  description: Server for AWS UK hosted organizations
- url: https://api.us.azure.sigmacomputing.com
  description: Server for Azure US hosted organizations
- url: https://api.eu.azure.sigmacomputing.com
  description: Server for Azure Europe hosted organizations
- url: https://api.ca.azure.sigmacomputing.com
  description: Server for Azure Canada hosted organizations
- url: https://api.uk.azure.sigmacomputing.com
  description: Server for Azure United Kingdom hosted organizations
- url: https://api.au.azure.sigmacomputing.com
  description: Server for Azure Australia hosted organizations
tags:
- name: workbooks
paths:
  /v2/workbooks:
    get:
      summary: List workbooks
      description: "This endpoint retrieves a list of all available workbooks.\n\n  Available workbooks include any workbooks in your My Documents folder and any workbooks you have access to.\n\n  Users with the Admin account type can optionally retrieve all workbooks in the organization.\n\n  ### Usage notes\n  This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.\n\n  #### Pagination\n\n  This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n\n  - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n  - total: The total number of entries available across all pages.\n  - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n  #### Example response for pagination\n ```json\n  {\n    \"hasMore\": true,\n    \"total\": 104,\n    \"nextPage\": \"50\"\n  }\n  ```\n\n  To request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return.\n\n  ### Usage scenarios\n  - **Workbook navigation:** Allows users to easily navigate through their collection of workbooks and access the one they need.\n  - **Integration points:** Useful for building integrations that need to present users with a list of their available workbooks, such as in custom applications using Sigma Embeds."
      parameters:
      - name: page
        schema:
          type: string
          description: Use to specify further pages using the string returned in the nextPage portion of the response.
          title: Page
        in: query
      - name: limit
        schema:
          type: number
          description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.
          title: Limit
        in: query
      - name: excludeTags
        schema:
          type: boolean
        in: query
      - name: skipPermissionCheck
        schema:
          type: boolean
          description: Only available to Sigma admins. Return all workbooks, including explorations, regardless of whether the user has access.
        in: query
      - name: isArchived
        schema:
          type: boolean
          description: Return archived workbooks.
        in: query
      - name: excludeExplorations
        schema:
          type: boolean
          description: When used with `skipPermissionCheck`, excludes explorations from the results, otherwise ignored.
        in: query
      operationId: listWorkbooks
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - entries
                  - nextPage
                  properties:
                    entries:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - workbookId
                          - workbookUrlId
                          - name
                          - url
                          - path
                          - latestVersion
                          - ownerId
                          properties:
                            workbookId:
                              type: string
                              description: Unique identifier of the workbook.
                              title: Workbook ID
                            workbookUrlId:
                              type: string
                            name:
                              type: string
                            url:
                              type: string
                            path:
                              type: string
                            latestVersion:
                              type: number
                            ownerId:
                              type: string
                        - type: object
                          required:
                          - createdBy
                          - updatedBy
                          - createdAt
                          - updatedAt
                          properties:
                            createdBy:
                              type: string
                              description: The identifier of the user who created this object.
                            updatedBy:
                              type: string
                              description: The identifier of the user or process that last updated this object.
                            createdAt:
                              type: string
                              format: date-time
                              description: When the object was created.
                            updatedAt:
                              type: string
                              format: date-time
                              description: When the object was last updated.
                        - type: object
                          properties:
                            isArchived:
                              type: boolean
                            tags:
                              type: array
                              items:
                                type: object
                                required:
                                - versionTagId
                                - name
                                - sourceWorkbookVersion
                                - taggedWorkbookId
                                - workbookTaggedAt
                                properties:
                                  versionTagId:
                                    type: string
                                    description: Unique identifier of the tag.
                                    title: Tag ID
                                  name:
                                    type: string
                                  sourceWorkbookVersion:
                                    type: number
                                  taggedWorkbookId:
                                    type: string
                                    description: Unique identifier of the tagged workbook.
                                    title: Workbook ID
                                  workbookTaggedAt:
                                    type: string
                                    format: date-time
                            description:
                              type: string
                      description: Array of results returned by the endpoint
                    nextPage:
                      type:
                      - string
                      - 'null'
                      description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`.
                - type: object
                  properties:
                    total:
                      type: number
                      description: Total number of results. Useful to determine if there is a need to paginate.
                    hasMore:
                      type: boolean
                      description: '**[Deprecated]** Indicates whether more results are available.'
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - workbooks
      security:
      - oauth2: []
    post:
      summary: Create a workbook
      description: 'This endpoint lets you create an empty workbook in Sigma, letting you start a data analysis project or report without any pre-existing templates or data sources set up.


        ### Usage notes

        - The `name` parameter is required to provide a name for the new workbook.

        - Use the **folderId** to specify the folder in which to save the workbook. Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.


        ### Usage scenarios

        - **Project initialization**: When starting a new project that requires data analysis or reporting, users can quickly generate a new blank workbook to begin structuring their data and analyses.

        - **Template preparation**: Administrators or team leads might create blank workbooks to set up standardized templates that their teams can use to maintain consistency in data handling and reporting.


        ### Best practices

        - **Naming conventions**: Establish and follow consistent naming conventions for workbooks to make it easier to manage and identify them within larger projects.

        - **Folder organization**: Use the **folderId** to organize workbooks into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams.

        - **Access control**: Regularly review and manage access permissions for new workbooks, ensuring that only the appropriate personnel can view or edit sensitive data.'
      parameters: []
      operationId: createWorkbook
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              allOf:
              - type: object
                required:
                - folderId
                - name
                properties:
                  folderId:
                    type: string
                    description: ID of the folder where the new workbook is created.
                    title: Folder ID
                  name:
                    type: string
                    description: Name of the new workbook.
                    title: Workbook Name
              - type: object
                properties:
                  description:
                    type: string
                    description: Description of the workbook.
                    title: Description
                  ownerId:
                    type: string
                    description: ID of the user (member) to own the workbook.
                    title: Owner ID
            examples:
              Create a blank workbook:
                value:
                  folderId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                  name: My new blank Workbook
                  description: This is a description
                  ownerId: FFFFFFFFFFFFFFF99999999999999
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - workbookId
                  - workbookUrlId
                  - name
                  - url
                  - path
                  - latestVersion
                  - ownerId
                  properties:
                    workbookId:
                      type: string
                      description: Unique identifier of the workbook.
                      title: Workbook ID
                    workbookUrlId:
                      type: string
                    name:
                      type: string
                    url:
                      type: string
                    path:
                      type: string
                    latestVersion:
                      type: number
                    ownerId:
                      type: string
                - type: object
                  required:
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  properties:
                    createdBy:
                      type: string
                      description: The identifier of the user who created this object.
                    updatedBy:
                      type: string
                      description: The identifier of the user or process that last updated this object.
                    createdAt:
                      type: string
                      format: date-time
                      description: When the object was created.
                    updatedAt:
                      type: string
                      format: date-time
                      description: When the object was last updated.
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                    tags:
                      type: array
                      items:
                        type: object
                        required:
                        - versionTagId
                        - name
                        - sourceWorkbookVersion
                        - taggedWorkbookId
                        - workbookTaggedAt
                        properties:
                          versionTagId:
                            type: string
                            description: Unique identifier of the tag.
                            title: Tag ID
                          name:
                            type: string
                          sourceWorkbookVersion:
                            type: number
                          taggedWorkbookId:
                            type: string
                            description: Unique identifier of the tagged workbook.
                            title: Workbook ID
                          workbookTaggedAt:
                            type: string
                            format: date-time
                    description:
                      type: string
              examples:
                Response Example:
                  value:
                    workbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    workbookUrlId: 57a96EMo3GVJG73179MV2l
                    name: My new Workbook
                    url: https://example.com/workbooks/88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    path: folder1
                    latestVersion: 1
                    isArchived: false
                    createdAt: '2022-01-01T00:00:00.000Z'
                    createdBy: user1
                    updatedAt: '2023-01-01T00:00:00.000Z'
                    updatedBy: user2
                    ownerId: user1
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - workbooks
      security:
      - oauth2: []
    servers:
    - url: https://api.sigmacomputing.com
      description: Server for GCP (US) hosted organizations
    - url: https://api.sa.gcp.sigmacomputing.com
      description: Server for GCP (KSA) hosted organizations
    - url: https://aws-api.sigmacomputing.com
      description: Server for AWS US (West) hosted organizations
    - url: https://api.us-a.aws.sigmacomputing.com
      description: Server for AWS US (East) hosted organizations
    - url: https://api.ca.aws.sigmacomputing.com
      description: Server for AWS Canada hosted organizations
    - url: https://api.eu.aws.sigmacomputing.com
      description: Server for AWS Europe hosted organizations
    - url: https://api.au.aws.sigmacomputing.com
      description: Server for AWS Australia and APAC hosted organizations
    - url: https://api.uk.aws.sigmacomputing.com
      description: Server for AWS UK hosted organizations
    - url: https://api.us.azure.sigmacomputing.com
      description: Server for Azure US hosted organizations
    - url: https://api.eu.azure.sigmacomputing.com
      description: Server for Azure Europe hosted organizations
    - url: https://api.ca.azure.sigmacomputing.com
      description: Server for Azure Canada hosted organizations
    - url: https://api.uk.azure.sigmacomputing.com
      description: Server for Azure United Kingdom hosted organizations
    - url: https://api.au.azure.sigmacomputing.com
      description: Server for Azure Australia hosted organizations
  /v2/workbooks/{workbookId}:
    get:
      summary: Get a workbook
      description: 'This endpoint retrieves a workbook by its unique identifier (`workbookId`). It provides detailed information about the workbook, including its name, URL, path, and other metadata. You can use this endpoint to fetch specific workbook details for display or further processing within client applications.


        ### Usage notes

        - The **workbookId** parameter must be a valid UUID that uniquely identifies the workbook. Invalid or nonexistent IDs return an error. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.


        ### Usage scenarios

        - **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific workbook to display its content or metadata in a custom user interface.

        - **Integration**: This endpoint is crucial for integrations where other systems need to fetch workbook details based on an ID provided through another interface or workflow.


        ### Best practices

        - Validate the **workbookId** on the client side before making a request to avoid unnecessary server load caused by invalid requests.'
      parameters:
      - name: workbookId
        schema:
          type: string
          description: Unique identifier of the workbook.
          title: Workbook ID
        in: path
        required: true
      operationId: getWorkbook
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - workbookId
                  - workbookUrlId
                  - name
                  - url
                  - path
                  - latestVersion
                  - ownerId
                  properties:
                    workbookId:
                      type: string
                      description: Unique identifier of the workbook.
                      title: Workbook ID
                    workbookUrlId:
                      type: string
                    name:
                      type: string
                    url:
                      type: string
                    path:
                      type: string
                    latestVersion:
                      type: number
                    ownerId:
                      type: string
                - type: object
                  required:
                  - createdBy
                  - updatedBy
                  - createdAt
                  - updatedAt
                  properties:
                    createdBy:
                      type: string
                      description: The identifier of the user who created this object.
                    updatedBy:
                      type: string
                      description: The identifier of the user or process that last updated this object.
                    createdAt:
                      type: string
                      format: date-time
                      description: When the object was created.
                    updatedAt:
                      type: string
                      format: date-time
                      description: When the object was last updated.
                - type: object
                  properties:
                    isArchived:
                      type: boolean
                    tags:
                      type: array
                      items:
                        type: object
                        required:
                        - versionTagId
                        - name
                        - sourceWorkbookVersion
                        - taggedWorkbookId
                        - workbookTaggedAt
                        properties:
                          versionTagId:
                            type: string
                            description: Unique identifier of the tag.
                            title: Tag ID
                          name:
                            type: string
                          sourceWorkbookVersion:
                            type: number
                          taggedWorkbookId:
                            type: string
                            description: Unique identifier of the tagged workbook.
                            title: Workbook ID
                          workbookTaggedAt:
                            type: string
                            format: date-time
                    description:
                      type: string
              examples:
                Response Example:
                  value:
                    workbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    workbookUrlId: 57a96EMo3GVJG73179MV2l
                    name: My workbook
                    url: https://example.com/workbooks/88889999-aaaa-bbbb-cccc-ddddeeeeffff
                    path: folder1
                    latestVersion: 1
                    createdAt: '2022-01-01T00:00:00.000Z'
                    createdBy: user1
                    updatedAt: '2023-01-01T00:00:00.000Z'
                    updatedBy: user2
                    ownerId: user1
                    isArchived: false
                    tags:
                    - versionTagId: 11111111-1111-1111-1111-111111111111
                      name: My tag
                      sourceWorkbookVersion: 1
                      taggedWorkbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff
                      workbookTaggedAt: '2022-02-01T00:00:00.000Z'
                    description: Describe my workbook
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - workbooks
      security:
      - oauth2: []
    servers:
    - url: https://api.sigmacomputing.com
      description: Server for GCP (US) hosted organizations
    - url: https://api.sa.gcp.sigmacomputing.com
      description: Server for GCP (KSA) hosted organizations
    - url: https://aws-api.sigmacomputing.com
      description: Server for AWS US (West) hosted organizations
    - url: https://api.us-a.aws.sigmacomputing.com
      description: Server for AWS US (East) hosted organizations
    - url: https://api.ca.aws.sigmacomputing.com
      description: Server for AWS Canada hosted organizations
    - url: https://api.eu.aws.sigmacomputing.com
      description: Server for AWS Europe hosted organizations
    - url: https://api.au.aws.sigmacomputing.com
      description: Server for AWS Australia and APAC hosted organizations
    - url: https://api.uk.aws.sigmacomputing.com
      description: Server for AWS UK hosted organizations
    - url: https://api.us.azure.sigmacomputing.com
      description: Server for Azure US hosted organizations
    - url: https://api.eu.azure.sigmacomputing.com
      description: Server for Azure Europe hosted organizations
    - url: https://api.ca.azure.sigmacomputing.com
      description: Server for Azure Canada hosted organizations
    - url: https://api.uk.azure.sigmacomputing.com
      description: Server for Azure United Kingdom hosted organizations
    - url: https://api.au.azure.sigmacomputing.com
      description: Server for Azure Australia hosted organizations
  /v2/workbooks/{workbookId}/bookmarks:
    get:
      summary: List bookmarks in a workbook
      description: "Returns a list of available bookmarks in a workbook. Available bookmarks are those that you have created or that have been shared with you.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Maintenance and governance**: Review workbook bookmarks for usage, validity, and freshness.\n  "
      parameters:
      - name: workbookId
        schema:
          type: string
          description: Unique identifier of the workbook.
          title: Workbook ID
        in: path
        required: true
      - name: page
        schema:
          type: string
          description: Use to specify further pages using the string returned in the nextPage portion of the response.
          title: Page
        in: query
      - name: limit
        schema:
          type: number
          description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.
          title: Limit
        in: query
      operationId: getWorkbookBookmarks
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - entries
                  - nextPage
                  properties:
                    entries:
                      type: array
                      items:
                        allOf:
                        - type: object
                          required:
                          - bookmarkId
                          - name
                          - isShared
                          - exploreKey
                          properties:
                            bookmarkId:
                              type: string
                            name:
                              type: string
                            isShared:
                              type: boolean
                              description: Whether the bookmark is shared.
                            exploreKey:
                              type: string
                              description: ID of the associated exploration.
                        - type: object
                          properties:
                            isDefault:
                              type: boolean
                              description: Whether the bookmark is default.
                    nextPage:
                      type:
                      - string
                      - 'null'
                - type: object
                  properties:
                    total:
                      type: number
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - workbooks
      security:
      - oauth2: []
    post:
      summary: Add a bookmark to a workbook
      description: "Add a bookmark to a workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n\n  "
      parameters:
      - name: workbookId
        schema:
          type: string
          description: Unique identifier of the workbook.
          title: Workbook ID
        in: path
        required: true
      operationId: postWorkbookBookmarks
      requestBody:
        description: The request body.
        content:
          application/json:
            schema:
              type: object
              required:
              - workbookVersion
              - name
              - isShared
              - exploreKey
              properties:
                workbookVersion:
                  type: number
                name:
                  type: string
                isShared:
                  type: boolean
                  description: Whether the bookmark is shared.
                exploreKey:
                  type: string
                  description: ID of the associated exploration.
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - bookmarkId
                  - name
                  - isShared
                  - exploreKey
                  properties:
                    bookmarkId:
                      type: string
                    name:
                      type: string
                    isShared:
                      type: boolean
                      description: Whether the bookmark is shared.
                    exploreKey:
                      type: string
                      description: ID of the associated exploration.
                - type: object
                  properties:
                    isDefault:
                      type: boolean
                      description: Whether the bookmark is default.
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - workbooks
      security:
      - oauth2: []
    servers:
    - url: https://api.sigmacomputing.com
      description: Server for GCP (US) hosted organizations
    - url: https://api.sa.gcp.sigmacomputing.com
      description: Server for GCP (KSA) hosted organizations
    - url: https://aws-api.sigmacomputing.com
      description: Server for AWS US (West) hosted organizations
    - url: https://api.us-a.aws.sigmacomputing.com
      description: Server for AWS US (East) hosted organizations
    - url: https://api.ca.aws.sigmacomputing.com
      description: Server for AWS Canada hosted organizations
    - url: https://api.eu.aws.sigmacomputing.com
      description: Server for AWS Europe hosted organizations
    - url: https://api.au.aws.sigmacomputing.com
      description: Server for AWS Australia and APAC hosted organizations
    - url: https://api.uk.aws.sigmacomputing.com
      description: Server for AWS UK hosted organizations
    - url: https://api.us.azure.sigmacomputing.com
      d

# --- truncated at 32 KB (14713 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-workbooks-api-openapi.yml