> 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 lineage of a workbook element GET https://api.sigmacomputing.com/v2/workbooks/{workbookId}/lineage/elements/{elementId} This endpoint retrieves the lineage and dependencies of a specific workbook element. It provides a detailed view of how data is interconnected within a workbook, which can be critical for understanding data sources and dependencies. ### Usage notes - **workbookId:** The UUID of the workbook containing the element. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - **elementId:** The UUID of the element within the workbook whose lineage is being queried. 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. - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error. ### Usage scenarios - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements. - **Debugging and optimization:** Helps in identifying and resolving issues in data processing or in the structure of workbook setups. - **Data source management**: Identify the data sources in use in a specific workbook. ### Best practices - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized. - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams. Reference: https://help.sigmacomputing.com/reference/list-lineage ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/workbooks/{workbookId}/lineage/elements/{elementId}: get: operationId: listLineage summary: List lineage of a workbook element description: >- This endpoint retrieves the lineage and dependencies of a specific workbook element. It provides a detailed view of how data is interconnected within a workbook, which can be critical for understanding data sources and dependencies. ### Usage notes - **workbookId:** The UUID of the workbook containing the element. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - **elementId:** The UUID of the element within the workbook whose lineage is being queried. 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. - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error. ### Usage scenarios - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements. - **Debugging and optimization:** Helps in identifying and resolving issues in data processing or in the structure of workbook setups. - **Data source management**: Identify the data sources in use in a specific workbook. ### Best practices - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized. - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams. tags: - Workbooks parameters: - name: workbookId in: path required: true schema: type: string - name: elementId in: path required: true schema: type: string - 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_listLineage_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: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies0: type: object properties: nodeId: type: string type: type: string required: - nodeId - type title: >- V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies0 V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies1: type: object properties: nodeId: type: string type: type: string name: type: string elementId: type: string required: - nodeId - type - name - elementId title: >- V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies1 V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies2: type: object properties: nodeId: type: string type: type: string name: type: string required: - nodeId - type - name title: >- V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies2 V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies: oneOf: - $ref: >- #/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies0 - $ref: >- #/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies1 - $ref: >- #/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies2 title: >- V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItemsType: type: string enum: - lookup - source - dependency title: >- V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItemsType V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItems: type: object properties: source: type: string target: type: string type: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItemsType required: - source - target - type title: >- V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItems workbooks_listLineage_Response_200: type: object properties: dependencies: type: object additionalProperties: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies edges: type: array items: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItems required: - dependencies - edges title: workbooks_listLineage_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Response** ```json { "dependencies": { "2MLjb1f67ldr3FMNI2L6Pf": { "name": "STATIONS", "nodeId": "2MLjb1f67ldr3FMNI2L6Pf", "type": "table" }, "4ZJD7G8AR03qf2oySPwoc3": { "elementId": "3fqWi0z9SWwxuilnuq8w34", "name": "Train Stations", "nodeId": "4ZJD7G8AR03qf2oySPwoc3", "type": "sheet" }, "Ttd4meevWGks3ZYdVWt8X": { "elementId": "5AbJJlOiPPtgpL3cCk7GqA", "name": "Sum of Dock Count by City", "nodeId": "Ttd4meevWGks3ZYdVWt8X", "type": "sheet" } }, "edges": [ { "source": "4ZJD7G8AR03qf2oySPwoc3", "target": "Ttd4meevWGks3ZYdVWt8X", "type": "source" }, { "source": "2MLjb1f67ldr3FMNI2L6Pf", "target": "4ZJD7G8AR03qf2oySPwoc3", "type": "source" } ] } ``` **SDK Code** ```python Response Example import requests url = "https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Response Example const url = 'https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Response Example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Response Example require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java Response Example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId") .header("Authorization", ".") .asString(); ``` ```php Response Example request('GET', 'https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp Response Example using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift Response Example import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage/elements/elementId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```