Lineage

Get lineage with entity count based pagination

Get lineage entities with pagination support, optionally filtered by node depth

get/v1/lineage/getLineageByEntityCount

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/lineage/getLineageByEntityCount
  • Auth: HTTP bearer

Query parameters

fqnstring required

fqn

direction'Upstream' | 'Downstream' required

Direction of lineage traversal

frominteger

Starting offset for pagination (0-based)

sizeinteger

Number of entities to return in this page

nodeDepthinteger required

Filter entities by specific node depth level (optional)

maxDepthinteger

Maximum depth to traverse in the specified direction

upstreamDepthinteger

Maximum upstream depth to use when calculating pagination info

downstreamDepthinteger

Maximum downstream depth to use when calculating pagination info

query_filterstring

Elasticsearch query that will be combined with the query_string query generator from the query argument

includeDeletedboolean

Filter documents by deleted param. By default deleted is false

entityTypestring

entity type

fieldsstring

Source Fields to Include

column_filterstring

Column-level lineage filter. Supports filtering by column names, tags, or glossary terms (e.g., 'columnName:customer_id', 'tag:PII', 'glossary:BusinessTerm')

preserve_pathsboolean

When true, preserves all nodes in the path to filtered results. When false, only returns nodes matching the filter. Default is false.

include_pagination_infoboolean

When true, includes pagination totals and depth counts in the entity-count response.

startTimeinteger

Filter lineage edges by observed time window (epoch millis). Inclusive lower bound; matched via range overlap on edge createdAt/updatedAt.

endTimeinteger

Filter lineage edges by observed time window (epoch millis). Inclusive upper bound; matched via range overlap on edge createdAt/updatedAt.

Response

lineage response

nodesobject
upstreamEdgesobject
downstreamEdgesobject

Changes

No recorded changes to this operation across all 1 revision of this API.