List lineage for a workbook

GET

/v2/workbooks/:workbookId/lineage

GET

/v2/workbooks/:workbookId/lineage

$ curl https://api.sigmacomputing.com/v2/workbooks/workbookId/lineage \
>      -H "Authorization: Bearer <token>"

200Response Example

1 {
2   "entries": [
3     {
4       "dataSourceIds": [
5         "QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn"
6       ],
7       "elementId": "5AbJJlOiPPtgpL3cCk7GqA",
8       "sourceIds": [
9         "QzcnTZrK9y8TjZs0T6OKO"
10       ],
11       "type": "element"
12     },
13     {
14       "dataSourceIds": [
15         "QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn"
16       ],
17       "elementId": "5AbJJlOiPPtgpL3cCk7GqA",
18       "sourceIds": [
19         "4ZJD7G8AR03qf2oySPwoc3"
20       ],
21       "type": "element"
22     },
23     {
24       "dataSourceIds": [
25         "QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn",
26         "d5a56ed4-16bf-4de3-be32-e0738f31be42"
27       ],
28       "elementId": "3fqWi0z9SWwxuilnuq8w34",
29       "sourceIds": [
30         "2MLjb1f67ldr3FMNI2L6Pf",
31         "4ZJD7G8AR03qf2oySPwoc3"
32       ],
33       "type": "element"
34     },
35     {
36       "connectionId": "dd76be0a-08bc-4c88-8a79-9956f933e701",
37       "dataModelId": "d5a56ed4-16bf-4de3-be32-e0738f31be42",
38       "dataSourceIds": [
39         "string"
40       ],
41       "datasourceId": "QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn",
42       "elementId": "string",
43       "sourceIds": [
44         "string"
45       ],
46       "type": "data-model"
47     },
48     {
49       "connectionId": "dd76be0a-08bc-4c88-8a79-9956f933e701",
50       "dataSourceIds": [
51         "string"
52       ],
53       "datasourceId": "d5a56ed4-16bf-4de3-be32-e0738f31be42",
54       "elementId": "string",
55       "inodeId": "eef50bc2-16c5-44ee-a913-9ae9d95e5295",
56       "inodeName": "DOCKS",
57       "sourceIds": [
58         "string"
59       ],
60       "type": "table"
61     }
62   ],
63   "nextPage": null
64 }

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 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.

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

Unique identifier of the workbook.

Query parameters

pagestringOptional

Use to specify further pages using the string returned in the nextPage portion of the response.

limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.

entrieslist of objects

nextPagestring or null

totaldoubleOptional