Altimate AI TABLES API

The TABLES API from Altimate AI — 30 operation(s) for tables.

OpenAPI Specification

altimate-ai-tables-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS TABLES API
  version: 0.1.0
tags:
- name: TABLES
paths:
  /tables/:
    get:
      tags:
      - TABLES
      summary: Get All
      description: 'Gets all tables.

        - datasources: search parameter

        - databases: search parameter

        - schemas: search parameter

        - contract_ids: search parameter

        - keyword: general search parameter for table name or column name'
      operationId: get_all_tables__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      - name: datasource_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Datasource Type
      - name: datasources
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Datasources
      - name: databases
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Databases
      - name: schemas
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Schemas
      - name: contract_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: integer
          - type: 'null'
          title: Contract Ids
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tags
      - name: keyword
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Keyword
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_TableFetchResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get All Tables  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get All Tables  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/items/{table_id}:
    get:
      tags:
      - TABLES
      summary: Get Table By Id
      operationId: get_table_by_id_tables_items__table_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table By Id Tables Items  Table Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table By Id Tables Items  Table Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/filters:
    get:
      tags:
      - TABLES
      summary: Get Filter
      description: Gets table filters.
      operationId: get_filter_tables_filters_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Filter Tables Filters Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Filter Tables Filters Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/column/{column_id}:
    patch:
      tags:
      - TABLES
      summary: Update Table Schema Metadata
      operationId: update_table_schema_metadata_tables_column__column_id__patch
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: column_id
        in: path
        required: true
        schema:
          type: integer
          title: Column Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableSchemaMetadataUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Update Table Schema Metadata Tables Column  Column Id  Patch
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Update Table Schema Metadata Tables Column  Column Id  Patch
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Update Table Schema Metadata Tables Column  Column Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/{table_id}:
    patch:
      tags:
      - TABLES
      summary: Update Table Metadata
      operationId: update_table_metadata_tables__table_id__patch
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableMetadataUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Update Table Metadata Tables  Table Id  Patch
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Update Table Metadata Tables  Table Id  Patch
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Update Table Metadata Tables  Table Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/columns/tags/:
    get:
      tags:
      - TABLES
      summary: Get Column Badges For Filter
      operationId: get_column_badges_for_filter_tables_columns_tags__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Column Badges For Filter Tables Columns Tags  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Column Badges For Filter Tables Columns Tags  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Column Badges For Filter Tables Columns Tags  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/custom/{table_id}:
    post:
      tags:
      - TABLES
      summary: Upsert Custom Table Tag
      operationId: upsert_custom_table_tag_tables_custom__table_id__post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: string
          title: Table Id
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableUpsertCustomTagRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableUpsertCustomTagResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Upsert Custom Table Tag Tables Custom  Table Id  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Upsert Custom Table Tag Tables Custom  Table Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/insights/{table_id}:
    get:
      tags:
      - TABLES
      summary: Get Table Insights
      operationId: get_table_insights_tables_insights__table_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableInsightsResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Insights Tables Insights  Table Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Insights Tables Insights  Table Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/insights_status/{table_id}:
    get:
      tags:
      - TABLES
      summary: Get Table Insights Status
      operationId: get_table_insights_status_tables_insights_status__table_id__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Insights Status Tables Insights Status  Table Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Insights Status Tables Insights Status  Table Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/table_description/{table_id}:
    get:
      tags:
      - TABLES
      summary: Get Table Description From Resource Id
      operationId: get_table_description_from_resource_id_tables_table_description__table_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Table Description From Resource Id Tables Table Description  Table Id  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Description From Resource Id Tables Table Description  Table Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Description From Resource Id Tables Table Description  Table Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/storage_details/{table_id}:
    get:
      tags:
      - TABLES
      summary: Get Table Storage Details
      operationId: get_table_storage_details_tables_storage_details__table_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/TableStorageOverTimeResponse'
                - type: 'null'
                title: Response Get Table Storage Details Tables Storage Details  Table Id  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Storage Details Tables Storage Details  Table Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Storage Details Tables Storage Details  Table Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/recent:
    get:
      tags:
      - TABLES
      summary: Get Recently Accessed Table
      operationId: get_recently_accessed_table_tables_recent_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - items:
                    $ref: '#/components/schemas/TablesAccessedResponse'
                  type: array
                - type: 'null'
                title: Response Get Recently Accessed Table Tables Recent Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Get Recently Accessed Table Tables Recent Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Get Recently Accessed Table Tables Recent Get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /tables/access_history/:
    post:
      tags:
      - TABLES
      summary: Get Table Access History
      operationId: get_table_access_history_tables_access_history__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableAccessHistory'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_TableAccessResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Access History Tables Access History  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Access History Tables Access History  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/access_history/filters/:
    get:
      tags:
      - TABLES
      summary: Get Table Access History Filters
      operationId: get_table_access_history_filters_tables_access_history_filters__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_id
        in: query
        required: true
        schema:
          type: integer
          title: Table Id
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TableColumnObjectResponse'
                title: Response Get Table Access History Filters Tables Access History Filters  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Access History Filters Tables Access History Filters  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Access History Filters Tables Access History Filters  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/access_history/column/:
    post:
      tags:
      - TABLES
      summary: Get Column Access History
      operationId: get_column_access_history_tables_access_history_column__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableAccessHistoryColumns'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnUserAccessHistoryResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Column Access History Tables Access History Column  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Column Access History Tables Access History Column  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/tabledata:
    get:
      tags:
      - TABLES
      summary: Get Table Data
      operationId: get_table_data_tables_tabledata_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: ''
          title: Order By
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sort Order
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      - name: table_rk
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Table Rk
      - name: filter_schema
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Filter Schema
      - name: filter_db
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Filter Db
      - name: tag_rks
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tag Rks
      - name: total_cost
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          title: Total Cost
      - name: insertion_cost
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          title: Insertion Cost
      - name: storage_cost
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          title: Storage Cost
      - name: clustering_cost
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          title: Clustering Cost
      - name: min_reads
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Reads
      - name: min_writes
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Writes
      - name: min_read_write_ratio
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          title: Min Read Write Ratio
      - name: owners
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Owners
      - name: instance_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: integer
          - type: 'null'
          default: []
          title: Instance Ids
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_TableDataResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Data Tables Tabledata Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Data Tables Tabledata Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /tables/tabledata/costs-summary:
    get:
      tags:
      - TABLES
      summary: Get Annualized Costs Summary
      operationId: get_annualized_costs_summary_tables_tabledata_costs_summary_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Table Names
      - name: schema_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Schema Names
      - name: database_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          default: []
          title: Database Names
      - name: tag_rks
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tag Rks
      - name: 

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-tables-api-openapi.yml