List columns for a workbook element

View as Markdown
This endpoint retrieves a list of columns associated with a specific element within a workbook. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint. ### Usage scenarios - **Data exploration:** Helps 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, needing to know the data structure to map data accurately. ### Best practices - Validate the elementId to make sure it corresponds to the correct workbook element before querying. - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.
elementIdstringRequired
Unique identifier of the workbook element.

Query parameters

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

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.
entrieslist of objects
nextPagestring or null
totaldoubleOptional