List lineage of a workbook element

View as MarkdownOpen in Claude
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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
elementIdstringRequired

Response

The response body.
dependenciesmap from strings to objects
edgeslist of objects