get https://api.sigmacomputing.com/v2/workbooks//elements//columns
This endpoint retrieves a list of columns associated with a specific element within a workbook. It provides metadata about each column, such as names and data types, 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 endpoint.
- Retrieve the elementId by first calling the /v2/workbooks/{workbookId}/pages endpoint, then calling the /v2/workbooks/{workbookId}/pages/{pageId}/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.