Skip to content

List Lineage Entries

GET
/api/v1/lineage

List lineage entries with filters and pagination.

Provides paginated access to lineage entries with provenance-based filtering. Metadata filters query the JSONB metadata column for provenance fields (origin, url, title, document_id) that are accumulated during pipeline processing.

execution_id
Any of:
string format: uuid

Filter by execution ID

route_id
Any of:
string

Filter by route ID

status
Any of:
string

Filter by status (initiated, processing, completed, failed)

is_root
Any of:
boolean

Filter for root entries only (parent_correlation_id IS NULL)

url
Any of:
string

Filter by source URL (case-insensitive partial match on metadata)

origin
Any of:
string

Filter by origin hostname (case-insensitive partial match on metadata)

title
Any of:
string

Filter by title (case-insensitive partial match on metadata)

document_id
Any of:
string

Filter by document ID (exact match on metadata)

started_after
Any of:
string format: date-time

Filter entries started at or after this time (ISO 8601)

started_before
Any of:
string format: date-time

Filter entries started at or before this time (ISO 8601)

sort_by
Sort By

Sort field: started_at, completed_at, route_id, stage_name

string
default: started_at

Sort field: started_at, completed_at, route_id, stage_name

sort_order
Sort Order

Sort direction: asc or desc

string
default: asc

Sort direction: asc or desc

limit
Limit

Max results per page

integer
default: 100 >= 1 <= 1000

Max results per page

offset
Offset

Offset for pagination

integer
0

Offset for pagination

Successful Response

LineageListResponse

Paginated lineage list.

object
entries
required
Entries

List of lineage entries

Array<object>
LineageEntryResponse

Pipeline lineage entry response.

object
id
required
Id

Lineage entry UUID

string format: uuid
correlation_id
required
Correlation Id

Correlation ID for this processing attempt

string
parent_correlation_id
Any of:
string
replay_batch_id
Any of:
string
execution_id
Any of:
string format: uuid
route_id
Any of:
string
adapter_name
Any of:
string
adapter_index
Any of:
integer
stage_name
required
Stage Name

Stage name

string
stage_status
required
Stage Status

Current status of this stage

string
Allowed values: pending initiated processing completed failed cancelled
stage_input_hash
Any of:
string
started_at
required
Started At

When processing started

string format: date-time
completed_at
Any of:
string format: date-time
duration_ms
Any of:
number
metadata
Any of:
object
key
additional properties
any
error_info
Any of:
object
key
additional properties
any
total
required
Total

Total number of entries

integer
limit
required
Limit

Maximum entries per page

integer
offset
required
Offset

Offset from start

integer
has_more
required
Has More

Whether more entries exist

boolean

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object