Altimate AI Lineage API

The Lineage API from Altimate AI — 13 operation(s) for lineage.

OpenAPI Specification

altimate-ai-lineage-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS Lineage API
  version: 0.1.0
tags:
- name: Lineage
paths:
  /lineage/upstream:
    post:
      tags:
      - Lineage
      summary: Post Upstream Tables
      description: Gets all upstream tables
      operationId: post_upstream_tables_lineage_upstream_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FQNRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectedTables'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Upstream Tables Lineage Upstream Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Upstream Tables Lineage Upstream Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /lineage/downstream:
    post:
      tags:
      - Lineage
      summary: Post Downstream Tables
      description: Gets all downstream tables
      operationId: post_downstream_tables_lineage_downstream_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FQNRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectedTables'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Downstream Tables Lineage Downstream Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Downstream Tables Lineage Downstream Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /lineage/connected:
    post:
      tags:
      - Lineage
      summary: Post Connected Columns
      description: Gets connected columns
      operationId: post_connected_columns_lineage_connected_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectedColumnsRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnLineageResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Connected Columns Lineage Connected Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Connected Columns Lineage Connected Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /lineage/v2/connected:
    post:
      tags:
      - Lineage
      summary: Post Connected Columns V2
      operationId: post_connected_columns_v2_lineage_v2_connected_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectedColumnsRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnLineageResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Connected Columns V2 Lineage V2 Connected Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Connected Columns V2 Lineage V2 Connected Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /lineage/export_final_columns:
    get:
      tags:
      - Lineage
      summary: Export Final Columns
      operationId: export_final_columns_lineage_export_final_columns_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: column_rk
        in: query
        required: true
        schema:
          type: string
          title: Column Rk
      - name: upstream
        in: query
        required: true
        schema:
          type: boolean
          title: Upstream
      - name: downstream
        in: query
        required: true
        schema:
          type: boolean
          title: Downstream
      - name: direct
        in: query
        required: true
        schema:
          type: boolean
          title: Direct
      - name: indirect
        in: query
        required: true
        schema:
          type: boolean
          title: Indirect
      responses:
        '200':
          description: Successful Response
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Export Final Columns Lineage Export Final Columns Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Export Final Columns Lineage Export Final Columns Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lineage/export_final_tables:
    get:
      tags:
      - Lineage
      summary: Export Final Tables
      operationId: export_final_tables_lineage_export_final_tables_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_rk
        in: query
        required: true
        schema:
          type: string
          title: Table Rk
      - name: upstream
        in: query
        required: true
        schema:
          type: boolean
          title: Upstream
      - name: downstream
        in: query
        required: true
        schema:
          type: boolean
          title: Downstream
      responses:
        '200':
          description: Successful Response
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Export Final Tables Lineage Export Final Tables Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Export Final Tables Lineage Export Final Tables Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lineage/terminal:
    get:
      tags:
      - Lineage
      summary: Get Terminal Node Response
      description: Get amundsen table from altimate table
      operationId: get_terminal_node_response_lineage_terminal_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: query
        required: false
        schema:
          type: integer
          title: Table Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableNodeResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Terminal Node Response Lineage Terminal Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Terminal Node Response Lineage Terminal Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lineage/schema:
    get:
      tags:
      - Lineage
      summary: Get Terminal Node Schema Response
      description: Get amundsen table from altimate table
      operationId: get_terminal_node_schema_response_lineage_schema_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Table Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableSchemaResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Terminal Node Schema Response Lineage Schema Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Terminal Node Schema Response Lineage Schema Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lineage/snowflake_stage:
    get:
      tags:
      - Lineage
      summary: Get Snowflake Stage Response
      operationId: get_snowflake_stage_response_lineage_snowflake_stage_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_rk
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Table Rk
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnowflakeStageResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Snowflake Stage Response Lineage Snowflake Stage Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Snowflake Stage Response Lineage Snowflake Stage Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lineage/dbt_info:
    get:
      tags:
      - Lineage
      summary: Get Snowflake Dbt Info
      operationId: get_snowflake_dbt_info_lineage_dbt_info_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_rk
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Table Rk
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbtInfoResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Snowflake Dbt Info Lineage Dbt Info Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Snowflake Dbt Info Lineage Dbt Info Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /lineage/v2/upstream:
    post:
      tags:
      - Lineage
      summary: Post Upstream Assets V2
      description: 'Gets all upstream assets using v2 asset_lineage table

        Supports tables, dashboards, and other asset types'
      operationId: post_upstream_assets_v2_lineage_v2_upstream_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FQNRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectedAssets'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Upstream Assets V2 Lineage V2 Upstream Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Upstream Assets V2 Lineage V2 Upstream Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /lineage/v2/downstream:
    post:
      tags:
      - Lineage
      summary: Post Downstream Assets V2
      description: 'Gets all downstream assets using v2 asset_lineage table

        Supports tables, dashboards, and other asset types'
      operationId: post_downstream_assets_v2_lineage_v2_downstream_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FQNRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectedAssets'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Downstream Assets V2 Lineage V2 Downstream Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Downstream Assets V2 Lineage V2 Downstream Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /lineage/v2/terminal:
    get:
      tags:
      - Lineage
      summary: Get Terminal Asset V2 Response
      description: 'Get terminal asset node using v2 asset_lineage table

        Supports tables, dashboards, and other asset types'
      operationId: get_terminal_asset_v2_response_lineage_v2_terminal_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: asset_rk
        in: query
        required: true
        schema:
          type: string
          title: Asset Rk
      - name: asset_type
        in: query
        required: false
        schema:
          type: string
          default: table
          title: Asset Type
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/TableAsset'
                - $ref: '#/components/schemas/DashboardAsset'
                title: Response Get Terminal Asset V2 Response Lineage V2 Terminal Get
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Terminal Asset V2 Response Lineage V2 Terminal Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Terminal Asset V2 Response Lineage V2 Terminal Get
        '404':
          description: Asset not found
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 404 Get Terminal Asset V2 Response Lineage V2 Terminal Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TestMetadata:
      properties:
        name:
          type: string
          title: Name
      type: object
      required:
      - name
      title: TestMetadata
    ColumnLineageResponse:
      properties:
        highlight_edges:
          items:
            $ref: '#/components/schemas/ColumnLineageEdge'
          type: array
          title: Highlight Edges
      type: object
      required:
      - highlight_edges
      title: ColumnLineageResponse
    DbtInfo:
      properties:
        project_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Name
        model_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Name
        full_refresh:
          anyOf:
          - type: string
          - type: 'null'
          title: Full Refresh
        last_refreshed:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Refreshed
        last_run_cost:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Run Cost
        last_run_duration:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Run Duration
      type: object
      title: DbtInfo
    DashboardAsset:
      properties:
        asset_rk:
          type: string
          title: Asset Rk
        asset_type:
          type: string
          title: Asset Type
          default: dashboard
        upstream_count:
          type: integer
          title: Upstream Count
          default: 0
        downstream_count:
          type: integer
          title: Downstream Count
          default: 0
        dashboard_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Dashboard Id
        dashboard_name:
          type: string
          title: Dashboard Name
        dashboard_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Dashboard Url
        workbook_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Workbook Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
        last_modified:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Modified
      type: object
      required:
      - asset_rk
      - dashboard_name
      title: DashboardAsset
      description: Dashboard asset with dashboard-specific fields
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ColumnLineageEdge:
      properties:
        source:
          type: string
          title: Source
        target:
          type: string
          title: Target
        extra:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Extra
      type: object
      required:
      - source
      - target
      title: ColumnLineageEdge
    SchemaMetadata:
      properties:
        table_schema_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Table Schema Id
        rk:
          type: string
          title: Rk
        name:
          type: string
          title: Name
        datatype:
          type: string
          title: Datatype
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        tags:
          items:
            $ref: '#/components/schemas/app__schemas__lineage__Tag'
          type: array
          title: Tags
        can_lineage_expand:
          type: boolean
          title: Can Lineage Expand
        is_transformation:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Transformation
          default: false
      type: object
      required:
      - rk
      - name
      - datatype
      - tags
      - can_lineage_expand
      title: SchemaMetadata
    ConnectedTables:
      properties:
        tables:
          items:
            $ref: '#/components/schemas/TableNodeResponse'
          type: array
          title: Tables
      type: object
      required:
      - tables
      title: ConnectedTables
    SnowflakeStageResponse:
      properties:
        rk:
          type: string
          title: Rk
        name:
          type: string
          title: Name
        stage_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage Url
        stage_region:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage Region
        stage_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage Type
        stage_owner:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage Owner
      type: object
      required:
      - rk
      - name
      title: SnowflakeStageResponse
    app__schemas__lineage__Tag:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        rk:
          anyOf:
          - type: string
          - type: 'null'
          title: Rk
      type: object
      required:
      - name
      - description
      title: Tag
    Edge:
      properties:
        src:
          type: string
          title: Src
        dst:
          type: string
          title: Dst
      type: object
      required:
      - src
      - dst
      title: Edge
    TableSchemaResponse:
      properties:
        table:
          type: string
          title: Table
        columns:
          items:
            $ref: '#/components/schemas/SchemaMetadata'
          type: array
          title: Columns
        purpose:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
        last_modified_by:
          anyOf:
          - type: integer
          - type: 'null'
          title: Last Modified By
      type: object
      required:
      - table
      - columns
      title: TableSchemaResponse
    FQNRequest:
      properties:
        fqn:
          type: string
          title: Fqn
      type: object
      required:
      - fqn
      title: FQNRequest
    ConnectedAssets:
      properties:
        assets:
          items:
            anyOf:
            - $ref: '#/components/schemas/TableAsset'
            - $ref: '#/components/schemas/DashboardAsset'
          type: array
          title: Assets
      type: object
      required:
      - assets
      title: ConnectedAssets
      description: Response containing list of connected assets
    DbtInfoResponse:
      properties:
        dbt_info:
          anyOf:
          - $ref: '#/components/schemas/DbtInfo'
          - type: 'null'
      type: object
      title: DbtInfoResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    TableAsset:
      properties:
        asset_rk:
          type: string
          title: Asset Rk
        asset_type:
          type: string
          title: Asset Type
          default: table
        upstream_count:
          type: integer
          title: Upstream Count
          default: 0
        downstream_count:
          type: integer
          title: Downstream Count
          default: 0
        table:
          type: string
          title: Table
        id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Id
        materialization:
          anyOf:
          - type: string
          - type: 'null'
          title: Materialization
        label:
          type: string
          title: Label
        schema_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Schema Name
        resource_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Type
        tests:
          anyOf:
          - items:
              $ref: '#/components/schemas/TestMetadata'
            type: array
          - type: 'null'
          title: Tests
      type: object
      required:
      - asset_rk
      - table
      - label
      title: TableAsset
      description: Table asset with table-specific fields
    TableNodeResponse:
      properties:
        table:
          type: string
          title: Table
        upstream_count:
          type: integer
          title: Upstream Count
        downstream_count:
          type: integer
          title: Downstream Count
        id:
          anyOf:
          - type: integer
          - type: string
          - type: 'null'
          title: Id
        materialization:
          anyOf:
          - type: string
          - type: 'null'
          title: Materialization
        label:
          type: string
          title: Label
        schema_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Schema Name
        resource_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Type
        tests:
          anyOf:
          - items:
              $ref: '#/components/schemas/TestMetadata'
            type: array
          - type: 'null'
          title: Tests
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
        is_stale:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Stale
        last_seen:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Seen
      type: object
      required:
      - table
      - upstream_count
      - downstream_count
      - label
      title: TableNodeResponse
    ConnectedColumnsRequest:
      properties:
        column_fqns:
          items:
            type: string
          type: array
          title: Column Fqns
        edges:
          anyOf:
          - items:
              $ref: '#/components/schemas/Edge'
            type: array
          - type: 'null'
          title: Edges
          default: []
        nodes:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Nodes
          default: []
        upstreamExpansion:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Upstreamexpansion
          default: false
        showIndirectEdges:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Showindirectedges
          default: false
      type: object
      required:
      - column_fqns
      title: ConnectedColumnsRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer