Export lineage - Gable Docs

GET

lineage

export

Export lineage

curl --request GET \
  --url https://{hostname}.gable.ai/v0/lineage/export \
  --header 'X-API-KEY: <api-key>'

{
  "timestamp": "<string>",
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runId": "<string>",
      "name": "<string>",
      "ingresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "egresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "paths": [
        {
          "ingress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "egress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "codeAnchors": [
            {
              "anchorId": "<string>",
              "name": "<string>",
              "codeUri": {
                "file": "<string>",
                "lineStart": 123,
                "columnStart": 123,
                "lineEnd": 123,
                "columnEnd": 123
              },
              "url": "<string>"
            }
          ],
          "fieldMappings": [
            {
              "ingressField": "<string>",
              "egressField": "<string>",
              "notes": "<string>"
            }
          ],
          "transformationSummary": "<string>",
          "transformationSummaryDetailed": "<string>"
        }
      ],
      "type": "<string>",
      "metadata": {
        "extras": {}
      }
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

run_id

string<uuid>

required

UUID of the run

Response

Lineage export

timestamp

string

required

The timestamp of the lineage export

items

object[]

required

The items in the lineage export

Option 1
Option 2
Option 3

Show child attributes

items.id

string<uuid>

required

The unique identifier for the component.

items.runId

string

required

The ID of the run that the component belongs to

items.name

string

required

The name of the component.

items.ingresses

object[]

required

The ingresses associated with the component.

Show child attributes

items.ingresses.id

string<uuid>

required

The unique identifier for the ingress/egress.

items.ingresses.kind

string

required

The kind of the ingress/egress.

items.ingresses.schema

object

required

The schema of the ingress/egress.

Show child attributes

items.ingresses.schema.type

enum<string>

required

Available options:

struct

items.ingresses.schema.name

string

items.ingresses.schema.fields

object[]

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12
Option 13

Show child attributes

items.ingresses.schema.fields.type

enum<string>

required

Available options:

struct

items.ingresses.schema.fields.name

string

items.ingresses.schema.fields.fields

array

items.ingresses.schema.fields.alias

string

items.ingresses.schema.fields.doc

string

items.ingresses.schema.fields.logical

string

items.ingresses.schema.fields.optional

boolean

items.ingresses.schema.alias

string

items.ingresses.schema.doc

string

items.ingresses.schema.logical

string

items.ingresses.signatureName

string

The name of the package, class, or method that the ingress/egress point is associated with.

items.egresses

object[]

required

The egresses associated with the component.

Show child attributes

items.egresses.id

string<uuid>

required

The unique identifier for the ingress/egress.

items.egresses.kind

string

required

The kind of the ingress/egress.

items.egresses.schema

object

required

The schema of the ingress/egress.

Show child attributes

items.egresses.schema.type

enum<string>

required

Available options:

struct

items.egresses.schema.name

string

items.egresses.schema.fields

object[]

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12
Option 13

Show child attributes

items.egresses.schema.fields.type

enum<string>

required

Available options:

struct

items.egresses.schema.fields.name

string

items.egresses.schema.fields.fields

array

items.egresses.schema.fields.alias

string

items.egresses.schema.fields.doc

string

items.egresses.schema.fields.logical

string

items.egresses.schema.fields.optional

boolean

items.egresses.schema.alias

string

items.egresses.schema.doc

string

items.egresses.schema.logical

string

items.egresses.signatureName

string

The name of the package, class, or method that the ingress/egress point is associated with.

items.paths

object[]

required

The paths associated with the component.

Show child attributes

items.paths.ingress

object

required

Show child attributes

items.paths.ingress.id

string<uuid>

required

The unique identifier of the ingress where the path starts.

items.paths.ingress.codeAnchorId

string<uuid>

The unique identifier of the code anchor node where the path starts (optional for BYOL imports).

items.paths.ingress.description

string

An AI-generated summary of the ingress point.

items.paths.egress

object

required

Show child attributes

items.paths.egress.id

string<uuid>

required

The unique identifier of the egress where the path ends.

items.paths.egress.codeAnchorId

string<uuid>

The unique identifier of the code anchor node where the path starts (optional for BYOL imports).

items.paths.egress.description

string

An AI-generated summary of the egress point.

items.paths.codeAnchors

object[]

required

A list of node IDs that are part of this path.

Show child attributes

items.paths.codeAnchors.anchorId

string

required

Unique identifier for the anchor.

items.paths.codeAnchors.name

string

required

Human readable name of the code anchor.

items.paths.codeAnchors.codeUri

object

required

Code URI is a unique identifier for a code location. It is used to identify the code location in the codebase.

Show child attributes

items.paths.codeAnchors.codeUri.file

string

required

Relative file path in the repo.

items.paths.codeAnchors.codeUri.lineStart

integer

required

items.paths.codeAnchors.codeUri.columnStart

integer

required

items.paths.codeAnchors.codeUri.lineEnd

integer

items.paths.codeAnchors.codeUri.columnEnd

integer

items.paths.codeAnchors.url

string

URL to the code anchor.

items.paths.fieldMappings

object[]

required

A list of field mappings that describe how fields are mapped along the path.

Show child attributes

items.paths.fieldMappings.ingressField

string

required

The name of the ingress field in the mapping.

items.paths.fieldMappings.egressField

string

required

The name of the egress field in the mapping.

items.paths.fieldMappings.notes

string

Additional notes about the field mapping.

items.paths.transformationSummary

string

An AI-generated summary of the data transformation that occurs along this path.

items.paths.transformationSummaryDetailed

string

A detailed AI-generated summary of the data transformation that occurs along this path.

items.type

string

required

The type of the component.

Allowed value: "CODE"

items.metadata

object

Show child attributes

items.metadata.extras

object

Additional metadata for the code component.

Show child attributes

items.metadata.extras.{key}

string

Get all componentsGet all components

⌘I

Export lineage

curl --request GET \
  --url https://{hostname}.gable.ai/v0/lineage/export \
  --header 'X-API-KEY: <api-key>'

{
  "timestamp": "<string>",
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runId": "<string>",
      "name": "<string>",
      "ingresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "egresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "paths": [
        {
          "ingress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "egress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "codeAnchors": [
            {
              "anchorId": "<string>",
              "name": "<string>",
              "codeUri": {
                "file": "<string>",
                "lineStart": 123,
                "columnStart": 123,
                "lineEnd": 123,
                "columnEnd": 123
              },
              "url": "<string>"
            }
          ],
          "fieldMappings": [
            {
              "ingressField": "<string>",
              "egressField": "<string>",
              "notes": "<string>"
            }
          ],
          "transformationSummary": "<string>",
          "transformationSummaryDetailed": "<string>"
        }
      ],
      "type": "<string>",
      "metadata": {
        "extras": {}
      }
    }
  ]
}

Introduction

Gable

Authorizations

Query Parameters

Response