---
updatedAt: 2026-04-29T23:07:57.000Z
agentTools:
  projectIndex: https://docs.bigeye.com/llms.txt
---

# Get edge

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Metadata",
    "version": "version not set"
  },
  "paths": {
    "/api/v2/lineage/edges/{edgeId}": {
      "get": {
        "operationId": "LineageV2Service_GetLineageEdge",
        "parameters": [
          {
            "in": "path",
            "name": "edgeId",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generatedLineageEdgeV2"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runtimeError"
                }
              }
            }
          }
        },
        "summary": "Get edge",
        "tags": [
          "LineageV2Service"
        ]
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "Personal_API_Key": []
    }
  ],
  "servers": [
    {
      "url": "https://app.bigeye.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "Personal_API_Key": {
        "description": "Add 'apikey ' to the beginning of your api key",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    },
    "schemas": {
      "generatedCatalogPath": {
        "properties": {
          "columnName": {
            "type": "string"
          },
          "pathParts": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "schemaName": {
            "type": "string"
          },
          "sourceName": {
            "type": "string"
          },
          "tableName": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedCatalogSource": {
        "properties": {
          "customCatalogSource": {
            "$ref": "#/components/schemas/generatedCustomCatalogSource"
          },
          "customRepository": {
            "$ref": "#/components/schemas/generatedCustomRepository"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "integrationPartner": {
            "$ref": "#/components/schemas/generatedIntegrationPartner"
          },
          "name": {
            "type": "string"
          },
          "usesAgent": {
            "type": "boolean"
          },
          "warehouseVendor": {
            "$ref": "#/components/schemas/generatedWarehouseType"
          }
        },
        "type": "object"
      },
      "generatedCustomCatalogSource": {
        "properties": {
          "iconUrl": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedCustomIntegrationType": {
        "properties": {
          "description": {
            "type": "string"
          },
          "entityInfo": {
            "$ref": "#/components/schemas/generatedEntityInfo"
          },
          "iconUrl": {
            "type": "string"
          },
          "id": {
            "format": "int64",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/generatedIntegrationType"
          }
        },
        "type": "object"
      },
      "generatedCustomNodeType": {
        "properties": {
          "allowedChildNodeTypes": {
            "description": "Allowed child types, which may be either custom node types or catalog node types\n(e.g. DATA_NODE_TYPE_SCHEMA). Supersedes allowed_child_types.",
            "items": {
              "$ref": "#/components/schemas/generatedNodeType"
            },
            "type": "array"
          },
          "allowedChildTypes": {
            "description": "Deprecated: custom-node-type-only allowed children. Use allowed_child_node_types, which\nalso supports catalog node types. Still populated with the custom-type subset for\nbackwards compatibility.",
            "items": {
              "$ref": "#/components/schemas/generatedCustomNodeType"
            },
            "type": "array"
          },
          "allowedParentNodeTypes": {
            "description": "Allowed parent types, which may be either custom node types or catalog node types\n(e.g. DATA_NODE_TYPE_TABLE). Supersedes allowed_parent_types.",
            "items": {
              "$ref": "#/components/schemas/generatedNodeType"
            },
            "type": "array"
          },
          "allowedParentTypes": {
            "description": "Deprecated: custom-node-type-only allowed parents. Use allowed_parent_node_types, which\nalso supports catalog node types. Still populated with the custom-type subset for\nbackwards compatibility.",
            "items": {
              "$ref": "#/components/schemas/generatedCustomNodeType"
            },
            "type": "array"
          },
          "entityInfo": {
            "$ref": "#/components/schemas/generatedEntityInfo"
          },
          "id": {
            "format": "int64",
            "type": "string"
          },
          "integrationType": {
            "$ref": "#/components/schemas/generatedCustomIntegrationType"
          },
          "isColumnDisplay": {
            "title": "If true, this node type will be displayed as a column in lineage UIs",
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "namePlural": {
            "type": "string"
          },
          "showInImpactAnalysis": {
            "description": "If true, nodes of this type are surfaced as impacted entities in issue impact analysis (RCA)\nwhen they lie downstream of an issue.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "generatedCustomRepository": {
        "properties": {
          "entityInfo": {
            "$ref": "#/components/schemas/generatedEntityInfo"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "integrationType": {
            "$ref": "#/components/schemas/generatedCustomIntegrationType"
          },
          "name": {
            "type": "string"
          },
          "workspaceId": {
            "format": "int64",
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedDataNodeType": {
        "default": "DATA_NODE_TYPE_UNSPECIFIED",
        "description": " - DATA_NODE_TYPE_MC_STRATEGY_FOLDER: STRATEGY Formerly known as MicroStrategy\n - DATA_NODE_TYPE_AI_AGENT_SNOWFLAKE_INTELLIGENCE: AI_AGENT prefix: AI agents surfaced on the lineage graph.\nDeprecated: use the platform-agnostic DATA_NODE_TYPE_AI_AGENT instead.",
        "enum": [
          "DATA_NODE_TYPE_UNSPECIFIED",
          "DATA_NODE_TYPE_TABLE",
          "DATA_NODE_TYPE_COLUMN",
          "DATA_NODE_TYPE_SCHEMA",
          "DATA_NODE_TYPE_MC_TABLEAU_PROJECT",
          "DATA_NODE_TYPE_MC_TABLEAU_WORKBOOK",
          "DATA_NODE_TYPE_MC_TABLEAU_STORY",
          "DATA_NODE_TYPE_MC_TABLEAU_SHEET",
          "DATA_NODE_TYPE_MC_TABLEAU_DASHBOARD",
          "DATA_NODE_TYPE_MC_POWERBI_WORKSPACE",
          "DATA_NODE_TYPE_MC_POWERBI_REPORT",
          "DATA_NODE_TYPE_MC_POWERBI_PAGE",
          "DATA_NODE_TYPE_MC_POWERBI_DASHBOARD",
          "DATA_NODE_TYPE_MC_POWERCENTER_WORKFLOW",
          "DATA_NODE_TYPE_MC_POWERCENTER_TARGET",
          "DATA_NODE_TYPE_MC_POWERCENTER_TARGET_FIELD",
          "DATA_NODE_TYPE_MC_SSIS_PACKAGE",
          "DATA_NODE_TYPE_MC_SSIS_DESTINATION",
          "DATA_NODE_TYPE_MC_SSIS_DESTINATION_FIELD",
          "DATA_NODE_TYPE_CUSTOM",
          "DATA_NODE_TYPE_CUSTOM_ENTRY",
          "DATA_NODE_TYPE_MC_COGNOS_FOLDER",
          "DATA_NODE_TYPE_MC_COGNOS_REPORT",
          "DATA_NODE_TYPE_MC_COGNOS_QUERY",
          "DATA_NODE_TYPE_MC_SAP_BO_FOLDER",
          "DATA_NODE_TYPE_MC_SAP_BO_REPORT",
          "DATA_NODE_TYPE_MC_FDS_FOLDER",
          "DATA_NODE_TYPE_MC_FDS_FILE",
          "DATA_NODE_TYPE_MC_FDS_FIELD",
          "DATA_NODE_TYPE_MC_QLIK_REPLICATE_SCHEMA",
          "DATA_NODE_TYPE_MC_QLIK_REPLICATE_TABLE",
          "DATA_NODE_TYPE_MC_QLIK_REPLICATE_COLUMN",
          "DATA_NODE_TYPE_MC_LOOKER_FOLDER",
          "DATA_NODE_TYPE_MC_LOOKER_BOARD",
          "DATA_NODE_TYPE_MC_LOOKER_LOOK",
          "DATA_NODE_TYPE_MC_LOOKER_DASHBOARD",
          "DATA_NODE_TYPE_MC_LOOKER_VISUALIZATION",
          "DATA_NODE_TYPE_MC_CDM_TARGET",
          "DATA_NODE_TYPE_MC_CDM_TARGET_FIELD",
          "DATA_NODE_TYPE_MC_CDM_TEMP_TABLE",
          "DATA_NODE_TYPE_MC_CDM_TEMP_FIELD",
          "DATA_NODE_TYPE_MC_CDM_TRANSFORM_FILE",
          "DATA_NODE_TYPE_MC_SNAPLOGIC_PIPELINE",
          "DATA_NODE_TYPE_MC_SNAPLOGIC_WRITE",
          "DATA_NODE_TYPE_MC_SNAPLOGIC_FIELD",
          "DATA_NODE_TYPE_MC_DATASTAGE_OUTPUT",
          "DATA_NODE_TYPE_MC_DATASTAGE_OUTPUT_FIELD",
          "DATA_NODE_TYPE_MC_SSRS_FOLDER",
          "DATA_NODE_TYPE_MC_SSRS_REPORT",
          "DATA_NODE_TYPE_MC_QLIK_SENSE_VIS_DIMENSION",
          "DATA_NODE_TYPE_MC_QLIK_SENSE_VIS_MEASURE",
          "DATA_NODE_TYPE_MC_QLIK_SENSE_APPLICATION",
          "DATA_NODE_TYPE_MC_QLIK_SENSE_SHEET",
          "DATA_NODE_TYPE_MC_STRATEGY_FOLDER",
          "DATA_NODE_TYPE_MC_STRATEGY_DOSSIER",
          "DATA_NODE_TYPE_MC_STRATEGY_GRAPH",
          "DATA_NODE_TYPE_MC_STRATEGY_GRID",
          "DATA_NODE_TYPE_MC_STRATEGY_GRIDGRAPH",
          "DATA_NODE_TYPE_MC_ADF_STORED_PROC",
          "DATA_NODE_TYPE_MC_ADF_TARGET_TABLE",
          "DATA_NODE_TYPE_MC_ADF_COPY_SINK",
          "DATA_NODE_TYPE_MC_ADF_FIELD",
          "DATA_NODE_TYPE_MC_MATILLION_COMPONENT",
          "DATA_NODE_TYPE_MC_MATILLION_TARGET_TABLE",
          "DATA_NODE_TYPE_MC_MATILLION_TARGET_FIELD",
          "DATA_NODE_TYPE_SOURCE",
          "DATA_NODE_TYPE_DBT_CLOUD",
          "DATA_NODE_TYPE_DBT_CORE",
          "DATA_NODE_TYPE_MC_REPOSITORY",
          "DATA_NODE_TYPE_DBT_PROJECT",
          "DATA_NODE_TYPE_CUSTOM_REPOSITORY",
          "DATA_NODE_TYPE_MC_SSIS_DATA_FLOW",
          "DATA_NODE_TYPE_AI_AGENT_SNOWFLAKE_INTELLIGENCE",
          "DATA_NODE_TYPE_AI_AGENT"
        ],
        "type": "string"
      },
      "generatedEntityInfo": {
        "properties": {
          "createdBy": {
            "format": "int32",
            "type": "integer"
          },
          "createdEpochSeconds": {
            "format": "int64",
            "type": "string"
          },
          "updatedBy": {
            "format": "int32",
            "type": "integer"
          },
          "updatedEpochSeconds": {
            "format": "int64",
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedIntegrationPartner": {
        "default": "INTEGRATION_PARTNER_UNSPECIFIED",
        "enum": [
          "INTEGRATION_PARTNER_UNSPECIFIED",
          "INTEGRATION_PARTNER_TABLEAU",
          "INTEGRATION_PARTNER_DBT_CLOUD",
          "INTEGRATION_PARTNER_METACENTER",
          "INTEGRATION_PARTNER_DBT_CORE",
          "INTEGRATION_PARTNER_POWERBI",
          "INTEGRATION_PARTNER_POWERCENTER",
          "INTEGRATION_PARTNER_SSIS",
          "INTEGRATION_PARTNER_COGNOS",
          "INTEGRATION_PARTNER_SAP_BUSINESS_OBJECTS",
          "INTEGRATION_PARTNER_FDS",
          "INTEGRATION_PARTNER_QLIK_REPLICATE",
          "INTEGRATION_PARTNER_LOOKER",
          "INTEGRATION_PARTNER_CDM",
          "INTEGRATION_PARTNER_SNAPLOGIC",
          "INTEGRATION_PARTNER_DATASTAGE",
          "INTEGRATION_PARTNER_SSRS",
          "INTEGRATION_PARTNER_QLIK_SENSE",
          "INTEGRATION_PARTNER_STRATEGY",
          "INTEGRATION_PARTNER_ADF",
          "INTEGRATION_PARTNER_MATILLION",
          "INTEGRATION_PARTNER_ANTHROPIC"
        ],
        "type": "string"
      },
      "generatedIntegrationType": {
        "default": "INTEGRATION_TYPE_UNSPECIFIED",
        "enum": [
          "INTEGRATION_TYPE_UNSPECIFIED",
          "INTEGRATION_TYPE_BI_TOOL",
          "INTEGRATION_TYPE_ETL_TOOL",
          "INTEGRATION_TYPE_DATABASE"
        ],
        "type": "string"
      },
      "generatedLineageEdgeV2": {
        "properties": {
          "createdAt": {
            "format": "int64",
            "type": "string"
          },
          "downstream": {
            "$ref": "#/components/schemas/generatedLineageNodeV2"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "relationshipType": {
            "$ref": "#/components/schemas/generatedRelationshipType"
          },
          "updatedAt": {
            "format": "int64",
            "type": "string"
          },
          "upstream": {
            "$ref": "#/components/schemas/generatedLineageNodeV2"
          }
        },
        "type": "object"
      },
      "generatedLineageNodeV2": {
        "properties": {
          "catalogPath": {
            "$ref": "#/components/schemas/generatedCatalogPath"
          },
          "createdAt": {
            "format": "int64",
            "type": "string"
          },
          "customNodeType": {
            "$ref": "#/components/schemas/generatedCustomNodeType"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "nodeEntityId": {
            "format": "int32",
            "type": "integer"
          },
          "nodeName": {
            "type": "string"
          },
          "nodeType": {
            "$ref": "#/components/schemas/generatedDataNodeType"
          },
          "source": {
            "$ref": "#/components/schemas/generatedCatalogSource"
          },
          "updatedAt": {
            "format": "int64",
            "type": "string"
          },
          "usesAgent": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "generatedNodeType": {
        "properties": {
          "customNodeType": {
            "$ref": "#/components/schemas/generatedCustomNodeType"
          },
          "dataNodeType": {
            "$ref": "#/components/schemas/generatedDataNodeType"
          }
        },
        "type": "object"
      },
      "generatedRelationshipType": {
        "default": "RELATIONSHIP_TYPE_UNSPECIFIED",
        "enum": [
          "RELATIONSHIP_TYPE_UNSPECIFIED",
          "RELATIONSHIP_TYPE_LINEAGE",
          "RELATIONSHIP_TYPE_CONTAINMENT"
        ],
        "type": "string"
      },
      "generatedWarehouseType": {
        "default": "DATABASE_TYPE_UNSPECIFIED",
        "enum": [
          "DATABASE_TYPE_UNSPECIFIED",
          "DATABASE_TYPE_AWS_ATHENA",
          "DATABASE_TYPE_BIGQUERY",
          "DATABASE_TYPE_DATABRICKS",
          "DATABASE_TYPE_MYSQL",
          "DATABASE_TYPE_ORACLE",
          "DATABASE_TYPE_POSTGRES",
          "DATABASE_TYPE_PRESTO",
          "DATABASE_TYPE_REDSHIFT",
          "DATABASE_TYPE_SAP_HANA",
          "DATABASE_TYPE_SNOWFLAKE",
          "DATABASE_TYPE_SQL_SERVER",
          "DATABASE_TYPE_SYNAPSE",
          "DATABASE_TYPE_ROCKSET",
          "DATABASE_TYPE_VERTICA",
          "DATABASE_TYPE_AVATICA",
          "DATABASE_TYPE_DB2",
          "DATABASE_TYPE_TERADATA",
          "DATABASE_TYPE_NETEZZA",
          "DATABASE_TYPE_SALESFORCE"
        ],
        "type": "string"
      },
      "protobufAny": {
        "properties": {
          "typeUrl": {
            "type": "string"
          },
          "value": {
            "format": "byte",
            "type": "string"
          }
        },
        "type": "object"
      },
      "runtimeError": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer"
          },
          "details": {
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            },
            "type": "array"
          },
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```