List lineage for a report

GET

/v2/reports/:reportId/lineage

This endpoint lists the data elements in a report and their dependencies and relationships, providing a detailed view of how data is interconnected within a report.

Usage notes

Retrieve the reportId by calling the /v2/reports endpoint.

Usage scenarios

Data governance: Allows data managers to track how information is used and propagated through different report elements.
Debugging and optimization: Helps with identifying and resolving issues in data processing or report structure.
Data source management: Identify the dependencies of data sources in use in a specific report.

Best practices

Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.
Use this endpoint to regularly audit report structures, ensuring that all data connections and transformations are correct and optimized.

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

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.

1	{
2	"entries": [
3	{
4	"dataSourceIds": [
5	"string"
6	],
7	"elementId": "string",
8	"sourceIds": [
9	"string"
10	],
11	"type": "table"
12	}
13	],
14	"nextPageToken": "string"
15	}