Skip to main content
POST
/
api
/
lineage
/
v1
GetLineage
curl --request POST \
  --url https://developer.synq.io/api/lineage/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lineageDirection": "LINEAGE_DIRECTION_UNSPECIFIED",
  "startPoint": {
    "entities": {
      "entities": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ]
    }
  },
  "maxDepth": 123
}
'
{
  "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>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.synq.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
lineageDirection
enum<string>
required

Direction of the lineage to query.

Available options:
LINEAGE_DIRECTION_UNSPECIFIED,
LINEAGE_DIRECTION_UPSTREAM,
LINEAGE_DIRECTION_DOWNSTREAM,
LINEAGE_DIRECTION_UPSTREAM_DOWNSTREAM
​
startPoint
entities · object
required

Possible starting points to get lineage from.

​
maxDepth
integer<int32> | null

Response

200 - application/json

Success

​
lineage
Lineage · object

Lineage defines the lineage of table-like entities.