Lineage Enterprise

Use the Catalog API to retrieve lineage information about datasets (tables and views). The lineage object includes information about the dataset's sources, parent objects, and child objects.

Lineage Object

{
  "sources": [
    {
      "id": "21077e5d-fe6f-4a29-843f-58fa3acb17c2",
      "path": [
        "Samples"
      ],
      "tag": "Iz1v71CeTQY=",
      "type": "CONTAINER",
      "containerType": "SOURCE",
      "createdAt": "2022-02-14T21:57:48.794Z"
    }
  ],
  "parents": [
    {
      "id": "3419fa3a-b5b3-4438-b864-a27ec4e18752",
      "path": [
        "Samples",
        "samples.dremio.com",
        "zips.json"
      ],
      "tag": "MAntohVzwLw=",
      "type": "DATASET",
      "datasetType": "PROMOTED",
      "createdAt": "2023-01-18T18:49:09.669Z"
    }
  ],
  "children": [
    {
      "id": "170e211e-4235-4d8d-acb5-3d4dbfe99c75",
      "path": [
        "@dremio",
        "NYC_zip"
      ],
      "tag": "OWKrfpEKzW4=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-25T02:11:46.344Z"
    },
    {
      "id": "7f79c068-a3c3-4af7-8cd4-35896ef0a0e0",
      "path": [
        "@dremio",
        "Chicago_zip"
      ],
      "tag": "gsaDW5h4GCs=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-25T00:09:12.461Z"
    }
  ]
}

Lineage Attributes

{{< api-section file="data/software-api/lineage.json" data="lineageAttributes" >}}

sources

{{< api-section file="data/software-api/lineage.json" data="sourcesAttributes" >}}

parents

{{< api-section file="data/software-api/lineage.json" data="parentsAttributes" >}}

children

{{< api-section file="data/software-api/lineage.json" data="childrenAttributes" >}}

Retrieving Lineage Information About a Dataset

Retrieve lineage information about the specified dataset.

Method and URL

GET /api/v3/catalog/{id}/graph

Parameters

{{< api-section file="data/software-api/lineage.json" data="retrieveLineageParameters" >}}

Example Request

curl -X GET 'https://{hostname}/api/v3/catalog/d69b25a3-31c8-4d55-a7cc-dfee2290779b/graph' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

Example Response

{
  "sources": [
    {
      "id": "21077e5d-fe6f-4a29-843f-58fa3acb17c2",
      "path": [
        "Samples"
      ],
      "tag": "Iz1v71CeTQY=",
      "type": "CONTAINER",
      "containerType": "SOURCE",
      "createdAt": "2022-02-14T21:57:48.794Z"
    }
  ],
  "parents": [
    {
      "id": "3419fa3a-b5b3-4438-b864-a27ec4e18752",
      "path": [
        "Samples",
        "samples.dremio.com",
        "zips.json"
      ],
      "tag": "MAntohVzwLw=",
      "type": "DATASET",
      "datasetType": "PROMOTED",
      "createdAt": "2023-01-18T18:49:09.669Z"
    }
  ],
  "children": [
    {
      "id": "170e211e-4235-4d8d-acb5-3d4dbfe99c75",
      "path": [
        "@dremio",
        "NYC_zip"
      ],
      "tag": "OWKrfpEKzW4=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-25T02:11:46.344Z"
    },
    {
      "id": "7f79c068-a3c3-4af7-8cd4-35896ef0a0e0",
      "path": [
        "@dremio",
        "Chicago_zip"
      ],
      "tag": "gsaDW5h4GCs=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-25T00:09:12.461Z"
    }
  ]
}

Response Status Codes

{{< api-responses file="data/software-api/lineage.json" data="retrieveLineageResponseCodes" >}}