SIsigmacomputing
Workbooks

Get workbook schema

The Workbook Schema API is deprecated as of December 15, 2023. This endpoint is no longer compatible with workbook layouts. Workflows that use this endpoint must be replaced with the new endpoints listed below. The components in Workbook Schema API are available through individual endpoints to minimize the retrieval of unnecessary data.

get/v2/workbooks/{workbookId}/schema

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workbookIdstring required

Unique identifier of the workbook.

Query parameters

includeSqlboolean
tagstring

Response

The response body.

workbookIdstring required

Unique identifier of the workbook.

workbookUrlIdstring required
pagesobject required
sheetsobject required
variablesobject required
elementsobject required
sqlQueriesobject required
sqlQueryErrorsobject required

Changes

No recorded changes to this operation across all 1 revision of this API.