GET
/
api
/
lineage
/
v1
GetLineage
curl --request GET \
  --url https://developer.synq.io/api/lineage/v1 \
  --header 'Authorization: Bearer <token>'
{
  "lineage": {
    "nodes": [
      {
        "ids": [
          {
            "airflowDag": {
              "integrationId": "<string>",
              "dagId": "<string>"
            }
          }
        ],
        "position": "NODE_POSITION_UNSPECIFIED",
        "cllDetails": {
          "columns": [
            {
              "columnId": "<string>",
              "name": "<string>",
              "nativeType": "<string>"
            }
          ],
          "cllState": "CLL_STATE_UNSPECIFIED",
          "cllMessages": [
            "<string>"
          ]
        }
      }
    ],
    "nodeDependencies": [
      {
        "sourceNodeIdx": 123,
        "targetNodeIdx": 123
      }
    ],
    "isCll": true,
    "columnDependencies": [
      {
        "sourceNodeIdx": 123,
        "sourceNodeColumnId": "<string>",
        "targetNodeIdx": 123,
        "targetNodeColumnId": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
lineageDirection
enum<string>

Direction of the lineage to query.

Available options:
LINEAGE_DIRECTION_UNSPECIFIED,
LINEAGE_DIRECTION_UPSTREAM,
LINEAGE_DIRECTION_DOWNSTREAM,
LINEAGE_DIRECTION_UPSTREAM_DOWNSTREAM
​
startPoint.entities.entities.dbtCoreNode.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
startPoint.entities.entities.dbtCoreNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​
startPoint.entities.entities.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

​
startPoint.entities.entities.dbtCloudNode.accountId
string

Your dbt Cloud account id

​
startPoint.entities.entities.dbtCloudNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​
startPoint.entities.entities.bigqueryTable.project
string
required

BigQuery project

​
startPoint.entities.entities.bigqueryTable.dataset
string
required

BigQuery dataset id

​
startPoint.entities.entities.bigqueryTable.table
string
required

BigQuery table name

​
startPoint.entities.entities.snowflakeTable.account
string
required

Snowflake account

​
startPoint.entities.entities.snowflakeTable.database
string
required

Snowflake database

​
startPoint.entities.entities.snowflakeTable.schema
string
required

Snowflake schema

​
startPoint.entities.entities.snowflakeTable.table
string
required

Snowflake table

​
startPoint.entities.entities.redshiftTable.cluster
string

Redshift cluster

​
startPoint.entities.entities.redshiftTable.database
string
required

Redshift database

​
startPoint.entities.entities.redshiftTable.schema
string
required

Redshift schema

​
startPoint.entities.entities.redshiftTable.table
string
required

Redshift table

​
startPoint.entities.entities.postgresTable.host
string
required

Postgres hostname without port

​
startPoint.entities.entities.postgresTable.database
string
required

Postgres database

​
startPoint.entities.entities.postgresTable.schema
string
required

Postgres schema

​
startPoint.entities.entities.postgresTable.table
string
required

Postgres table

​
startPoint.entities.entities.mysqlTable.host
string
required

Mysql hostname without port

​
startPoint.entities.entities.mysqlTable.schema
string
required

Mysql database

​
startPoint.entities.entities.mysqlTable.table
string
required

Mysql table

​
startPoint.entities.entities.clickhouseTable.host
string
required

Clickhouse hostname without port

​
startPoint.entities.entities.clickhouseTable.schema
string
required

Clickhouse database

​
startPoint.entities.entities.clickhouseTable.table
string
required

Clickhouse table

​
startPoint.entities.entities.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
startPoint.entities.entities.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

​
startPoint.entities.entities.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
startPoint.entities.entities.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

​
startPoint.entities.entities.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

​
startPoint.entities.entities.custom.id
string
required

Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

​
startPoint.entities.entities.dataproduct.id
string
required

Dataproduct id that identifies the Dataproduct

​
startPoint.entities.entities.synqPath.path
string
required

SYNQ path that identifies the SYNQ entity, needs to be one of supported paths

​
startPoint.entities.entities.databricksTable.workspace
string
required

URL of Databricks workspace

​
startPoint.entities.entities.databricksTable.catalog
string
required

Databricks catalog

​
startPoint.entities.entities.databricksTable.schema
string
required

Databricks schema

​
startPoint.entities.entities.databricksTable.table
string
required

Databricks table or view

​
startPoint.entities.entities.trinoTable.host
string
required

Hostname of the Trino instance

​
startPoint.entities.entities.trinoTable.catalog
string
required

Trino catalog

​
startPoint.entities.entities.trinoTable.schema
string
required

Trino schema

​
startPoint.entities.entities.trinoTable.table
string
required

Trino table or view

​
startPoint.entities.entities.sqlMeshModel.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
startPoint.entities.entities.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

​
startPoint.entities.entities.sqlMeshAudit.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
startPoint.entities.entities.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

​
startPoint.entities.entities.sqlMeshAudit.auditId
string
required

Identifier of the audit

​
startPoint.entities.entities.monitor.monitorId
string
required

Identifier of the monitor

​
startPoint.entities.entities.monitor.segment
string

Optional monitor segmentation identifier

​
startPoint.entities.entities.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

​
startPoint.entityColumns.columnNames
string[]
​
maxDepth
integer

Response

200
application/json

Success

The response is of type object.