Skip to main content
GET
GET /v1/lineage/{entityType}/{id}

Get Lineage

Retrieve the lineage graph for an entity, including upstream and downstream edges. You can query by entity ID or fully qualified name.

Get by Entity Type and ID

entityType
string
required
Type of the entity. Options: table, dashboard, pipeline, topic, mlmodel, container, searchIndex, storedProcedure, dashboardDataModel, apiEndpoint.
id
string
required
UUID of the entity to retrieve lineage for.
upstreamDepth
integer
default:"1"
Number of hops to traverse upstream (min: 0, max: 3).
downstreamDepth
integer
default:"1"
Number of hops to traverse downstream (min: 0, max: 3).
includeDeleted
boolean
default:"false"
Include soft-deleted entities in the lineage graph.

Get by Entity Type and FQN

Use GET /v1/lineage/{entityType}/name/{fqn} to retrieve lineage by fully qualified name.
entityType
string
required
Type of the entity. Options: table, dashboard, pipeline, topic, mlmodel, container, searchIndex, storedProcedure, dashboardDataModel, apiEndpoint.
fqn
string
required
Fully qualified name of the entity (e.g., sample_data.ecommerce_db.shopify.dim_customer).
upstreamDepth
integer
default:"1"
Number of hops to traverse upstream (min: 0, max: 3).
downstreamDepth
integer
default:"1"
Number of hops to traverse downstream (min: 0, max: 3).
includeDeleted
boolean
default:"false"
Include soft-deleted entities in the lineage graph.
GET /v1/lineage/{entityType}/{id}

Returns

Returns the lineage graph centered on the requested entity, including upstream and downstream edges up to the specified depth.

Response

entity
object
The entity reference for the node at the center of the lineage graph.
nodes
array
List of entity references for all nodes in the lineage graph (excluding the center entity).
upstreamEdges
array
Edges pointing into the center entity (data sources).
downstreamEdges
array
Edges pointing away from the center entity (data destinations). Same structure as upstreamEdges.

Error Handling