# Collate Lineage API

**Canonical:** https://apis.io/apis/collate/collate-lineage-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Lineage API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Data Lineage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The `Lineage` for a given data asset, has information of the input datasets used and the ETL pipeline that created it.

## Operations (22)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/lineage` | Add a lineage edge |
| PUT | `/v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}` | Add a lineage edge by entity FQNs |
| DELETE | `/v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}` | Delete a lineage edge by FQNs |
| PATCH | `/v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}` | Patch a lineage edge by FQNs |
| DELETE | `/v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}` | Delete a lineage edge |
| PATCH | `/v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}` | Patch a lineage edge |
| DELETE | `/v1/lineage/{entityType}/{entityId}/type/{lineageSource}` | Delete a lineage edge by Type |
| DELETE | `/v1/lineage/source/name/{entityType}/{entityFQN}/type/{lineageSource}` | Delete lineage edges by type and entity FQN |
| GET | `/v1/lineage/export` | Export lineage |
| GET | `/v1/lineage/exportAsync` | Export lineage |
| GET | `/v1/lineage/exportByEntityCountAsync` | Export lineage by entity count |
| GET | `/v1/lineage/{entity}/{id}` | Get lineage by Id |
| GET | `/v1/lineage/{entity}/name/{fqn}` | Get lineage by fully qualified name |
| GET | `/v1/lineage/getLineageByEntityCount` | Get lineage with entity count based pagination |
| GET | `/v1/lineage/getLineageEdge/{fromId}/{toId}` | Get a lineage edge |
| GET | `/v1/lineage/getLineageEdge/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}` | Get a lineage edge by entity FQNs |
| GET | `/v1/lineage/getPaginationInfo` | Get lineage pagination information |
| POST | `/v1/lineage/hydrate` | Batch-hydrate lineage nodes into full entity objects |
| GET | `/v1/lineage/getDataQualityLineage` | Search Data Quality lineage |
| GET | `/v1/lineage/getPlatformLineage` | Get Platform Lineage |
| GET | `/v1/lineage/getLineage` | Search lineage |
| GET | `/v1/lineage/getLineage/{direction}` | Search lineage with Direction |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-lineage-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Data Lineage

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-lineage-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.