GET
/
api
/
lineage
/
v1
curl --request GET \
  --url https://developer.synq.io/api/lineage/v1 \
  --header 'Authorization: Bearer <token>'
{
  "lineage": {
    "nodes": [
      {
        "ids": [
          {
            "dbtCoreNode": {
              "integrationId": "<string>",
              "nodeId": "<string>"
            },
            "dbtCloudNode": {
              "projectId": "<string>",
              "accountId": "<string>",
              "nodeId": "<string>"
            },
            "bigqueryTable": {
              "project": "<string>",
              "dataset": "<string>",
              "table": "<string>"
            },
            "snowflakeTable": {
              "account": "<string>",
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "redshiftTable": {
              "cluster": "<string>",
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "postgresTable": {
              "host": "<string>",
              "database": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "mysqlTable": {
              "host": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "clickhouseTable": {
              "host": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "airflowDag": {
              "integrationId": "<string>",
              "dagId": "<string>"
            },
            "airflowTask": {
              "integrationId": "<string>",
              "dagId": "<string>",
              "taskId": "<string>"
            },
            "custom": {
              "id": "<string>"
            },
            "dataproduct": {
              "id": "<string>"
            },
            "synqPath": {
              "path": "<string>"
            },
            "databricksTable": {
              "workspace": "<string>",
              "catalog": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "trinoTable": {
              "host": "<string>",
              "catalog": "<string>",
              "schema": "<string>",
              "table": "<string>"
            },
            "sqlMeshModel": {
              "integrationId": "<string>",
              "fqn": "<string>"
            },
            "sqlMeshAudit": {
              "integrationId": "<string>",
              "fqn": "<string>",
              "auditId": "<string>"
            },
            "monitor": {
              "monitoredId": {},
              "monitorId": "<string>",
              "segment": "<string>",
              "integrationId": "<string>"
            }
          }
        ],
        "position": 123,
        "cllDetails": {
          "columns": [
            {
              "columnId": "<string>",
              "name": "<string>",
              "nativeType": "<string>"
            }
          ],
          "cllState": 123,
          "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
integer
startPoint.entityColumns.id.dbtCoreNode.integrationId
string

SYNQ integration_id that identifies the dbt Core project

startPoint.entityColumns.id.dbtCoreNode.nodeId
string

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

startPoint.entityColumns.id.dbtCloudNode.projectId
string

Your dbt Cloud project id

startPoint.entityColumns.id.dbtCloudNode.accountId
string

Your dbt Cloud account id

startPoint.entityColumns.id.dbtCloudNode.nodeId
string

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

startPoint.entityColumns.id.bigqueryTable.project
string

BigQuery project

startPoint.entityColumns.id.bigqueryTable.dataset
string

BigQuery dataset id

startPoint.entityColumns.id.bigqueryTable.table
string

BigQuery table name

startPoint.entityColumns.id.snowflakeTable.account
string

Snowflake account

startPoint.entityColumns.id.snowflakeTable.database
string

Snowflake database

startPoint.entityColumns.id.snowflakeTable.schema
string

Snowflake schema

startPoint.entityColumns.id.snowflakeTable.table
string

Snowflake table

startPoint.entityColumns.id.redshiftTable.cluster
string

Redshift cluster

startPoint.entityColumns.id.redshiftTable.database
string

Redshift database

startPoint.entityColumns.id.redshiftTable.schema
string

Redshift schema

startPoint.entityColumns.id.redshiftTable.table
string

Redshift table

startPoint.entityColumns.id.postgresTable.host
string

Postgres hostname without port

startPoint.entityColumns.id.postgresTable.database
string

Postgres database

startPoint.entityColumns.id.postgresTable.schema
string

Postgres schema

startPoint.entityColumns.id.postgresTable.table
string

Postgres table

startPoint.entityColumns.id.mysqlTable.host
string

Mysql hostname without port

startPoint.entityColumns.id.mysqlTable.schema
string

Mysql database

startPoint.entityColumns.id.mysqlTable.table
string

Mysql table

startPoint.entityColumns.id.clickhouseTable.host
string

Clickhouse hostname without port

startPoint.entityColumns.id.clickhouseTable.schema
string

Clickhouse database

startPoint.entityColumns.id.clickhouseTable.table
string

Clickhouse table

startPoint.entityColumns.id.airflowDag.integrationId
string

SYNQ integration_id that identifies the Airflow instance

startPoint.entityColumns.id.airflowDag.dagId
string

Airflow dag_id that identifies the DAG

startPoint.entityColumns.id.airflowTask.integrationId
string

SYNQ integration_id that identifies the Airflow instance

startPoint.entityColumns.id.airflowTask.dagId
string

Airflow dag_id that identifies the DAG

startPoint.entityColumns.id.airflowTask.taskId
string

Airflow task_id that identifies the task within the DAG

startPoint.entityColumns.id.custom.id
string

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

startPoint.entityColumns.id.dataproduct.id
string

Dataproduct id that identifies the Dataproduct

startPoint.entityColumns.id.synqPath.path
string

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

startPoint.entityColumns.id.databricksTable.workspace
string

URL of Databricks workspace

startPoint.entityColumns.id.databricksTable.catalog
string

Databricks catalog

startPoint.entityColumns.id.databricksTable.schema
string

Databricks schema

startPoint.entityColumns.id.databricksTable.table
string

Databricks table or view

startPoint.entityColumns.id.trinoTable.host
string

Hostname of the Trino instance

startPoint.entityColumns.id.trinoTable.catalog
string

Trino catalog

startPoint.entityColumns.id.trinoTable.schema
string

Trino schema

startPoint.entityColumns.id.trinoTable.table
string

Trino table or view

startPoint.entityColumns.id.sqlMeshModel.integrationId
string

SYNQ integration_id that identifies the dbt Core project

startPoint.entityColumns.id.sqlMeshModel.fqn
string

SQLMesh model fully qualified name

startPoint.entityColumns.id.sqlMeshAudit.integrationId
string

SYNQ integration_id that identifies the dbt Core project

startPoint.entityColumns.id.sqlMeshAudit.fqn
string

SQLMesh model fully qualified name

startPoint.entityColumns.id.sqlMeshAudit.auditId
string

Identifier of the audit

startPoint.entityColumns.id.monitor.monitoredId.dbtCoreNode.integrationId
string

SYNQ integration_id that identifies the dbt Core project

startPoint.entityColumns.id.monitor.monitoredId.dbtCoreNode.nodeId
string

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

startPoint.entityColumns.id.monitor.monitoredId.dbtCloudNode.projectId
string

Your dbt Cloud project id

startPoint.entityColumns.id.monitor.monitoredId.dbtCloudNode.accountId
string

Your dbt Cloud account id

startPoint.entityColumns.id.monitor.monitoredId.dbtCloudNode.nodeId
string

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

startPoint.entityColumns.id.monitor.monitoredId.bigqueryTable.project
string

BigQuery project

startPoint.entityColumns.id.monitor.monitoredId.bigqueryTable.dataset
string

BigQuery dataset id

startPoint.entityColumns.id.monitor.monitoredId.bigqueryTable.table
string

BigQuery table name

startPoint.entityColumns.id.monitor.monitoredId.snowflakeTable.account
string

Snowflake account

startPoint.entityColumns.id.monitor.monitoredId.snowflakeTable.database
string

Snowflake database

startPoint.entityColumns.id.monitor.monitoredId.snowflakeTable.schema
string

Snowflake schema

startPoint.entityColumns.id.monitor.monitoredId.snowflakeTable.table
string

Snowflake table

startPoint.entityColumns.id.monitor.monitoredId.redshiftTable.cluster
string

Redshift cluster

startPoint.entityColumns.id.monitor.monitoredId.redshiftTable.database
string

Redshift database

startPoint.entityColumns.id.monitor.monitoredId.redshiftTable.schema
string

Redshift schema

startPoint.entityColumns.id.monitor.monitoredId.redshiftTable.table
string

Redshift table

startPoint.entityColumns.id.monitor.monitoredId.postgresTable.host
string

Postgres hostname without port

startPoint.entityColumns.id.monitor.monitoredId.postgresTable.database
string

Postgres database

startPoint.entityColumns.id.monitor.monitoredId.postgresTable.schema
string

Postgres schema

startPoint.entityColumns.id.monitor.monitoredId.postgresTable.table
string

Postgres table

startPoint.entityColumns.id.monitor.monitoredId.mysqlTable.host
string

Mysql hostname without port

startPoint.entityColumns.id.monitor.monitoredId.mysqlTable.schema
string

Mysql database

startPoint.entityColumns.id.monitor.monitoredId.mysqlTable.table
string

Mysql table

startPoint.entityColumns.id.monitor.monitoredId.clickhouseTable.host
string

Clickhouse hostname without port

startPoint.entityColumns.id.monitor.monitoredId.clickhouseTable.schema
string

Clickhouse database

startPoint.entityColumns.id.monitor.monitoredId.clickhouseTable.table
string

Clickhouse table

startPoint.entityColumns.id.monitor.monitoredId.airflowDag.integrationId
string

SYNQ integration_id that identifies the Airflow instance

startPoint.entityColumns.id.monitor.monitoredId.airflowDag.dagId
string

Airflow dag_id that identifies the DAG

startPoint.entityColumns.id.monitor.monitoredId.airflowTask.integrationId
string

SYNQ integration_id that identifies the Airflow instance

startPoint.entityColumns.id.monitor.monitoredId.airflowTask.dagId
string

Airflow dag_id that identifies the DAG

startPoint.entityColumns.id.monitor.monitoredId.airflowTask.taskId
string

Airflow task_id that identifies the task within the DAG

startPoint.entityColumns.id.monitor.monitoredId.custom.id
string

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

startPoint.entityColumns.id.monitor.monitoredId.dataproduct.id
string

Dataproduct id that identifies the Dataproduct

startPoint.entityColumns.id.monitor.monitoredId.synqPath.path
string

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

startPoint.entityColumns.id.monitor.monitoredId.databricksTable.workspace
string

URL of Databricks workspace

startPoint.entityColumns.id.monitor.monitoredId.databricksTable.catalog
string

Databricks catalog

startPoint.entityColumns.id.monitor.monitoredId.databricksTable.schema
string

Databricks schema

startPoint.entityColumns.id.monitor.monitoredId.databricksTable.table
string

Databricks table or view

startPoint.entityColumns.id.monitor.monitoredId.trinoTable.host
string

Hostname of the Trino instance

startPoint.entityColumns.id.monitor.monitoredId.trinoTable.catalog
string

Trino catalog

startPoint.entityColumns.id.monitor.monitoredId.trinoTable.schema
string

Trino schema

startPoint.entityColumns.id.monitor.monitoredId.trinoTable.table
string

Trino table or view

startPoint.entityColumns.id.monitor.monitoredId.sqlMeshModel.integrationId
string

SYNQ integration_id that identifies the dbt Core project

startPoint.entityColumns.id.monitor.monitoredId.sqlMeshModel.fqn
string

SQLMesh model fully qualified name

startPoint.entityColumns.id.monitor.monitoredId.sqlMeshAudit.integrationId
string

SYNQ integration_id that identifies the dbt Core project

startPoint.entityColumns.id.monitor.monitoredId.sqlMeshAudit.fqn
string

SQLMesh model fully qualified name

startPoint.entityColumns.id.monitor.monitoredId.sqlMeshAudit.auditId
string

Identifier of the audit

startPoint.entityColumns.id.monitor.monitoredId.monitor.monitorId
string

Identifier of the monitor

startPoint.entityColumns.id.monitor.monitoredId.monitor.segment
string

Optional monitor segmentation identifier

startPoint.entityColumns.id.monitor.monitoredId.monitor.integrationId
string

SYNQ integration_id of the monitored identifier

startPoint.entityColumns.id.monitor.monitorId
string

Identifier of the monitor

startPoint.entityColumns.id.monitor.segment
string

Optional monitor segmentation identifier

startPoint.entityColumns.id.monitor.integrationId
string

SYNQ integration_id of the monitored identifier

startPoint.entityColumns.columnNames
string[]
maxDepth
integer

Response

200
application/json

OK

The response is of type object.