Before accessing the Lineage API, ensure you have an API token. If you haven’t already created one, follow the steps in 'Creating API token' to generate your token.
With the Foundational Lineage API, you can programmatically access accurate, real-time lineage insights. Use it to locate specific entities, view upstream and downstream flows, and much more.
Example Use Cases
Integrate with CI/CD
Trigger specific tests whenever a Pull Request modifies certain dashboards.
PII Labeling Automation
Automatically assign PII labels to all downstream entities derived from a PII column.
Automated Access Control
Automatically apply access control to a table based on the access rules of its upstream tables.
Risk Prioritization by Downstream Impact
Automatically generate a risk score for each table, factoring in the specific downstream entities (e.g., tables, dashboards) it could influence.
In addition to these scenarios, Foundational’s Policies page enables more automated workflows. Effortlessly define rules, like auto-assigning reviewers for table modifications or notifying Slack channels when specific downstream dashboards are affected.
API Documentation
The Foundational API is available and documented using OpenAPI, allowing you to explore and test it directly in your browser.
To explore the complete documentation and live-test each API endpoint, please visit the OpenAPI page for the Lineage API.
Example Code
To help you get started, a sample Python script for querying our API is included below.