SIsigmacomputing
Workbooks

List columns for all elements in a workbook

This endpoint retrieves all columns in a workbook for all element in the workbook.

Usage notes

Usage scenarios

  • Data exploration: Enable users to explore the data structure of a workbook element, facilitating deeper analysis and understanding.
  • Integration tasks: Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.

Best practices

  • Use this endpoint when setting up interfaces that require specific knowledge about the data structure.
get/v2/workbooks/{workbookId}/columns

Request

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

Path parameters

workbookIdstring required

Unique identifier of the workbook.

Query parameters

pagestring

Use to specify further pages using the string returned in the nextPage portion of the response.

limitnumber double

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.

Response

The response body.

nextPagestring nullable required
totalnumber double

Changes

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