List lineage for a workbook

View as MarkdownOpen in Claude
This endpoint lists the elements, data sources, and upstream lineage for those data sources in a workbook, providing a detailed view of how data is interconnected within a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements. - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or workbook structure. - **Data source management**: Identify the dependencies of data sources in use in a specific workbook. ### Best practices - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams. - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional
limitdoubleOptional

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldouble