Create Lineage Events - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

POST /v0/events

Create Lineage Events

cURL

curl --request POST \
  --url https://demo-api.gable.ai/v0/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "paths": [
    {
      "ingress": {
        "signature_name": "<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>"
        },
        "kind": "<string>",
        "description": "<string>",
        "id": "<string>",
        "payload_name": "<string>"
      },
      "egress": {
        "signature_name": "<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>"
        },
        "kind": "<string>",
        "description": "<string>",
        "id": "<string>",
        "payload_name": "<string>"
      },
      "code_anchors": [
        {
          "anchor_id": "<string>",
          "code_uri": {
            "file": "<string>",
            "line_start": 123,
            "column_start": 123,
            "line_end": 123,
            "column_end": 123
          }
        }
      ],
      "field_mappings": [
        {
          "ingress_field": "<string>",
          "egress_field": "<string>",
          "notes": "<string>",
          "field_data_flow_path": [
            {
              "anchor_id": "<string>",
              "code_uri": {
                "file": "<string>",
                "line_start": 123,
                "column_start": 123,
                "line_end": 123,
                "column_end": 123
              }
            }
          ]
        }
      ],
      "transformation_summary": "<string>",
      "transformation_summary_detailed": "<string>",
      "payload_name": "<string>"
    }
  ],
  "run_id": "<string>",
  "type": "CODE",
  "external_component_id": "<string>",
  "metadata": {
    "extras": {}
  },
  "name": "<string>",
  "upload_context": {
    "include_unchanged_assets": false,
    "type": "CODE",
    "collection_mechanism": "BYOL"
  }
}
'

Python

import requests

url = "https://demo-api.gable.ai/v0/events"

payload = {
    "paths": [
        {
            "ingress": {
                "signature_name": "<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>"
                },
                "kind": "<string>",
                "description": "<string>",
                "id": "<string>",
                "payload_name": "<string>"
            },
            "egress": {
                "signature_name": "<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>"
                },
                "kind": "<string>",
                "description": "<string>",
                "id": "<string>",
                "payload_name": "<string>"
            },
            "code_anchors": [
                {
                    "anchor_id": "<string>",
                    "code_uri": {
                        "file": "<string>",
                        "line_start": 123,
                        "column_start": 123,
                        "line_end": 123,
                        "column_end": 123
                    }
                }
            ],
            "field_mappings": [
                {
                    "ingress_field": "<string>",
                    "egress_field": "<string>",
                    "notes": "<string>",
                    "field_data_flow_path": [
                        {
                            "anchor_id": "<string>",
                            "code_uri": {
                                "file": "<string>",
                                "line_start": 123,
                                "column_start": 123,
                                "line_end": 123,
                                "column_end": 123
                            }
                        }
                    ]
                }
            ],
            "transformation_summary": "<string>",
            "transformation_summary_detailed": "<string>",
            "payload_name": "<string>"
        }
    ],
    "run_id": "<string>",
    "type": "CODE",
    "external_component_id": "<string>",
    "metadata": { "extras": {} },
    "name": "<string>",
    "upload_context": {
        "include_unchanged_assets": False,
        "type": "CODE",
        "collection_mechanism": "BYOL"
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
    method: 'POST',
    headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
    body: JSON.stringify({
        paths: [
          {
            ingress: {
              signature_name: '<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>'
              },
              kind: '<string>',
              description: '<string>',
              id: '<string>',
              payload_name: '<string>'
            },
            egress: {
              signature_name: '<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>'
              },
              kind: '<string>',
              description: '<string>',
              id: '<string>',
              payload_name: '<string>'
            },
            code_anchors: [
              {
                anchor_id: '<string>',
                code_uri: {
                  file: '<string>',
                  line_start: 123,
                  column_start: 123,
                  line_end: 123,
                  column_end: 123
                }
              }
            ],
            field_mappings: [
              {
                ingress_field: '<string>',
                egress_field: '<string>',
                notes: '<string>',
                field_data_flow_path: [
                  {
                    anchor_id: '<string>',
                    code_uri: {
                      file: '<string>',
                      line_start: 123,
                      column_start: 123,
                      line_end: 123,
                      column_end: 123
                    }
                  }
                ]
              }
            ],
            transformation_summary: '<string>',
            transformation_summary_detailed: '<string>',
            payload_name: '<string>'
          }
        ],
        run_id: '<string>',
        type: 'CODE',
        external_component_id: '<string>',
        metadata: {extras: {}},
        name: '<string>',
        upload_context: {include_unchanged_assets: false, type: 'CODE', collection_mechanism: 'BYOL'}
    })
};

fetch('https://demo-api.gable.ai/v0/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo-api.gable.ai/v0/events",
  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([
    'paths' => [
        [
                'ingress' => [
                                'signature_name' => '<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>'
                                ],
                                'kind' => '<string>',
                                'description' => '<string>',
                                'id' => '<string>',
                                'payload_name' => '<string>'
                ],
                'egress' => [
                                'signature_name' => '<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>'
                                ],
                                'kind' => '<string>',
                                'description' => '<string>',
                                'id' => '<string>',
                                'payload_name' => '<string>'
                ],
                'code_anchors' => [
                                [
                                                                'anchor_id' => '<string>',
                                                                'code_uri' => [
                                                                                                                                'file' => '<string>',
                                                                                                                                'line_start' => 123,
                                                                                                                                'column_start' => 123,
                                                                                                                                'line_end' => 123,
                                                                                                                                'column_end' => 123
                                                                ]
                                ]
                ],
                'field_mappings' => [
                                [
                                                                'ingress_field' => '<string>',
                                                                'egress_field' => '<string>',
                                                                'notes' => '<string>',
                                                                'field_data_flow_path' => [
                                                                                                                                [
                                                                                                                                                                                                                                                                'anchor_id' => '<string>',
                                                                                                                                                                                                                                                                'code_uri' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'file' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'line_start' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'column_start' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'line_end' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'column_end' => 123
                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'transformation_summary' => '<string>',
                'transformation_summary_detailed' => '<string>',
                'payload_name' => '<string>'
        ]
    ],
    'run_id' => '<string>',
    'type' => 'CODE',
    'external_component_id' => '<string>',
    'metadata' => [
        'extras' => [

]
    ],
    'name' => '<string>',
    'upload_context' => [
        'include_unchanged_assets' => false,
        'type' => 'CODE',
        'collection_mechanism' => 'BYOL'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

Go

package main

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

func main() {

url := "https://demo-api.gable.ai/v0/events"

payload := strings.NewReader("{\n  \"paths\": [\n    {\n      \"ingress\": {\n        \"signature_name\": \"<string>\",\n        \"schema\": {\n          \"type\": \"struct\",\n          \"name\": \"<string>\",\n          \"fields\": [\n            {\n              \"type\": \"struct\",\n              \"name\": \"<string>\",\n              \"fields\": \"<array>\",\n              \"alias\": \"<string>\",\n              \"doc\": \"<string>\",\n              \"logical\": \"<string>\",\n              \"optional\": true\n            }\n          ],\n          \"alias\": \"<string>\",\n          \"doc\": \"<string>\",\n          \"logical\": \"<string>\"\n        },\n        \"kind\": \"<string>\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"payload_name\": \"<string>\"\n      },\n      \"egress\": {\n        \"signature_name\": \"<string>\",\n        \"schema\": {\n          \"type\": \"struct\",\n          \"name\": \"<string>\",\n          \"fields\": [\n            {\n              \"type\": \"struct\",\n              \"name\": \"<string>\",\n              \"fields\": \"<array>\",\n              \"alias\": \"<string>\",\n              \"doc\": \"<string>\",\n              \"logical\": \"<string>\",\n              \"optional\": true\n            }\n          ],\n          \"alias\": \"<string>\",\n          \"doc\": \"<string>\",\n          \"logical\": \"<string>\"\n        },\n        \"kind\": \"<string>\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"payload_name\": \"<string>\"\n      },\n      \"code_anchors\": [\n        {\n          \"anchor_id\": \"<string>\",\n          \"code_uri\": {\n            \"file\": \"<string>\",\n            \"line_start\": 123,\n            \"column_start\": 123,\n            \"line_end\": 123,\n            \"column_end\": 123\n          }\n        }\n      ],\n      \"field_mappings\": [\n        {\n          \"ingress_field\": \"<string>\",\n          \"egress_field\": \"<string>\",\n          \"notes\": \"<string>\",\n          \"field_data_flow_path\": [\n            {\n              \"anchor_id\": \"<string>\",\n              \"code_uri\": {\n                \"file\": \"<string>\",\n                \"line_start\": 123,\n                \"column_start\": 123,\n                \"line_end\": 123,\n                \"column_end\": 123\n              }\n            }\n          ]\n        }\n      ],\n      \"transformation_summary\": \"<string>\",\n      \"transformation_summary_detailed\": \"<string>\",\n      \"payload_name\": \"<string>\"\n    }\n  ],\n  \"run_id\": \"<string>\",\n  \"type\": \"CODE\",\n  \"external_component_id\": \"<string>\",\n  \"metadata\": {\n    \"extras\": {}\n  },\n  \"name\": \"<string>\",\n  \"upload_context\": {\n    \"include_unchanged_assets\": false,\n    \"type\": \"CODE\",\n    \"collection_mechanism\": \"BYOL\"\n  }\n}")

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

req.Header.Add("X-API-KEY", "<api-key>")
    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))
}