> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # List columns for a workbook element GET https://api.sigmacomputing.com/v2/workbooks/{workbookId}/elements/{elementId}/columns 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. Reference: https://help.sigmacomputing.com/reference/get-element-columns ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/workbooks/{workbookId}/elements/{elementId}/columns: get: operationId: getElementColumns summary: List columns for a workbook element description: >- 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. tags: - Workbooks parameters: - name: workbookId in: path required: true schema: type: string - name: elementId in: path required: true schema: type: string - name: page in: query required: false schema: type: string - name: limit in: query required: false schema: type: number format: double - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: '#/components/schemas/workbooks_getElementColumns_Response_200' 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 components: schemas: V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType: type: object properties: {} description: The column's data type, represented as a recursive type object. title: >- V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: columnId: type: string description: Column ID label: type: string description: Column name formula: type: string description: Column formula type: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType description: The column's data type, represented as a recursive type object. required: - columnId - label - formula - type title: >- V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems workbooks_getElementColumns_Response_200: type: object properties: entries: type: array items: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getElementColumns_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json {} ``` **Response** ```json { "entries": [ { "columnId": "col_9f8b7a6d", "label": "Total Sales", "formula": "SUM(Sales)", "type": { "format": "decimal", "precision": 2, "type": "number" } }, { "columnId": "col_4d3e2f1a", "label": "Order Date", "formula": "OrderDate", "type": { "format": "yyyy-MM-dd", "type": "date" } }, { "columnId": "col_7a1c3b5e", "label": "Customer Name", "formula": "CustomerName", "type": { "maxLength": 255, "type": "string" } } ], "nextPage": null, "total": 3 } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns" payload = {} headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns'; const options = { method: 'GET', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns', [ 'body' => '{}', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/workbooks/workbookId/elements/elementId/columns")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```