Skip to main content
POST
/
api
/
datawarehouse
/
v1
/
connection
/
{connection_id}
/
upload
/
{upload_id}
/
lineage
IngestLineage
curl --request POST \
  --url https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stateAt": "2023-11-07T05:31:56Z",
  "scope": {
    "databases": {
      "databases": [
        "<string>"
      ]
    }
  },
  "edges": [
    {
      "upstream": {
        "fqn": {
          "objectName": "<string>",
          "instanceName": "<string>",
          "databaseName": "<string>",
          "schemaName": "<string>"
        }
      },
      "downstream": {
        "fqn": {
          "objectName": "<string>",
          "instanceName": "<string>",
          "databaseName": "<string>",
          "schemaName": "<string>"
        }
      },
      "columnEdges": [
        {
          "upstreamColumn": "<string>",
          "downstreamColumn": "<string>"
        }
      ],
      "meta": {}
    }
  ]
}
'
import requests

url = "https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage"

payload = {
    "stateAt": "2023-11-07T05:31:56Z",
    "scope": { "databases": { "databases": ["<string>"] } },
    "edges": [
        {
            "upstream": { "fqn": {
                    "objectName": "<string>",
                    "instanceName": "<string>",
                    "databaseName": "<string>",
                    "schemaName": "<string>"
                } },
            "downstream": { "fqn": {
                    "objectName": "<string>",
                    "instanceName": "<string>",
                    "databaseName": "<string>",
                    "schemaName": "<string>"
                } },
            "columnEdges": [
                {
                    "upstreamColumn": "<string>",
                    "downstreamColumn": "<string>"
                }
            ],
            "meta": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    stateAt: '2023-11-07T05:31:56Z',
    scope: {databases: {databases: ['<string>']}},
    edges: [
      {
        upstream: {
          fqn: {
            objectName: '<string>',
            instanceName: '<string>',
            databaseName: '<string>',
            schemaName: '<string>'
          }
        },
        downstream: {
          fqn: {
            objectName: '<string>',
            instanceName: '<string>',
            databaseName: '<string>',
            schemaName: '<string>'
          }
        },
        columnEdges: [{upstreamColumn: '<string>', downstreamColumn: '<string>'}],
        meta: {}
      }
    ]
  })
};

fetch('https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'stateAt' => '2023-11-07T05:31:56Z',
    'scope' => [
        'databases' => [
                'databases' => [
                                '<string>'
                ]
        ]
    ],
    'edges' => [
        [
                'upstream' => [
                                'fqn' => [
                                                                'objectName' => '<string>',
                                                                'instanceName' => '<string>',
                                                                'databaseName' => '<string>',
                                                                'schemaName' => '<string>'
                                ]
                ],
                'downstream' => [
                                'fqn' => [
                                                                'objectName' => '<string>',
                                                                'instanceName' => '<string>',
                                                                'databaseName' => '<string>',
                                                                'schemaName' => '<string>'
                                ]
                ],
                'columnEdges' => [
                                [
                                                                'upstreamColumn' => '<string>',
                                                                'downstreamColumn' => '<string>'
                                ]
                ],
                'meta' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage"

	payload := strings.NewReader("{\n  \"stateAt\": \"2023-11-07T05:31:56Z\",\n  \"scope\": {\n    \"databases\": {\n      \"databases\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"edges\": [\n    {\n      \"upstream\": {\n        \"fqn\": {\n          \"objectName\": \"<string>\",\n          \"instanceName\": \"<string>\",\n          \"databaseName\": \"<string>\",\n          \"schemaName\": \"<string>\"\n        }\n      },\n      \"downstream\": {\n        \"fqn\": {\n          \"objectName\": \"<string>\",\n          \"instanceName\": \"<string>\",\n          \"databaseName\": \"<string>\",\n          \"schemaName\": \"<string>\"\n        }\n      },\n      \"columnEdges\": [\n        {\n          \"upstreamColumn\": \"<string>\",\n          \"downstreamColumn\": \"<string>\"\n        }\n      ],\n      \"meta\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"stateAt\": \"2023-11-07T05:31:56Z\",\n  \"scope\": {\n    \"databases\": {\n      \"databases\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"edges\": [\n    {\n      \"upstream\": {\n        \"fqn\": {\n          \"objectName\": \"<string>\",\n          \"instanceName\": \"<string>\",\n          \"databaseName\": \"<string>\",\n          \"schemaName\": \"<string>\"\n        }\n      },\n      \"downstream\": {\n        \"fqn\": {\n          \"objectName\": \"<string>\",\n          \"instanceName\": \"<string>\",\n          \"databaseName\": \"<string>\",\n          \"schemaName\": \"<string>\"\n        }\n      },\n      \"columnEdges\": [\n        {\n          \"upstreamColumn\": \"<string>\",\n          \"downstreamColumn\": \"<string>\"\n        }\n      ],\n      \"meta\": {}\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/lineage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"stateAt\": \"2023-11-07T05:31:56Z\",\n  \"scope\": {\n    \"databases\": {\n      \"databases\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"edges\": [\n    {\n      \"upstream\": {\n        \"fqn\": {\n          \"objectName\": \"<string>\",\n          \"instanceName\": \"<string>\",\n          \"databaseName\": \"<string>\",\n          \"schemaName\": \"<string>\"\n        }\n      },\n      \"downstream\": {\n        \"fqn\": {\n          \"objectName\": \"<string>\",\n          \"instanceName\": \"<string>\",\n          \"databaseName\": \"<string>\",\n          \"schemaName\": \"<string>\"\n        }\n      },\n      \"columnEdges\": [\n        {\n          \"upstreamColumn\": \"<string>\",\n          \"downstreamColumn\": \"<string>\"\n        }\n      ],\n      \"meta\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
connection_id
string
required

Identifier of the warehouse connection this lineage was read from. Use the same connection_id you use for the other Ingest* calls of this warehouse so the lineage attaches to the right objects.

​
upload_id
string<uuid>
required

A unique id for this batch (UUID). Re-sending a batch with the same upload_id is de-duplicated, so it is safe to retry.

Body

application/json

IngestLineageRequest carries one batch of lineage edges for a single warehouse connection. Send many batches with the same connection_id over time; each batch is interpreted against the others according to replace_mode.

​
stateAt
string<date-time>
required

Time at which the lineage was extracted from the warehouse. timestamp.gt = 2022-01-01T00:00:00Z timestamp.gt_lt = 2022-01-01T00:00:00Z timestamp.gt_lt_exclusive = 2022-01-01T00:00:00Z timestamp.gt_lte = 2022-01-01T00:00:00Z timestamp.gt_lte_exclusive = 2022-01-01T00:00:00Z timestamp.lt_now = true

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

​
source
enum<string>

How the lineage was derived. Drives the precedence of the resulting edges and keeps lineage of different origins from overwriting one another.

Available options:
LINEAGE_SOURCE_UNSPECIFIED,
LINEAGE_SOURCE_DWH_NATIVE,
LINEAGE_SOURCE_QUERY_HISTORY,
LINEAGE_SOURCE_DECLARED,
LINEAGE_SOURCE_VIEW_DEFINITION
​
replaceMode
enum<string>

How this batch supersedes previously-ingested lineage. Defaults to MERGE (incremental) when unset.

Available options:
LINEAGE_REPLACE_MODE_UNSPECIFIED,
LINEAGE_REPLACE_MODE_MERGE,
LINEAGE_REPLACE_MODE_REPLACE_SCOPE
​
scope
databases · object

Required when replace_mode is REPLACE_SCOPE; ignored otherwise.

​
edges
LineageEdge · object[]

The lineage edges in this batch. Empty in REPLACE_SCOPE mode is a valid way to expire all lineage inside the scope.

Response

200 - application/json

Success

IngestLineageResponse is intentionally empty; a successful call means the batch was accepted for processing.