Altimate AI QUERIES API

The QUERIES API from Altimate AI — 18 operation(s) for queries.

OpenAPI Specification

altimate-ai-queries-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS QUERIES API
  version: 0.1.0
tags:
- name: QUERIES
paths:
  /query/:
    get:
      tags:
      - QUERIES
      summary: Get All Queries
      operationId: get_all_queries_query__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tags
      - name: warehouses
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouses
      - name: users
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Users
      - name: sortAttribute
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: query_cost
          title: Sortattribute
      - name: sortOrder
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sortorder
      - name: executionTimeFilter
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          default: 0
          title: Executiontimefilter
      - name: executionCostFilter
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          default: 0
          title: Executioncostfilter
      - name: query_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Hash
      - name: query_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Id
      - name: session_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session Id
      - name: query_parameterized_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Parameterized Hash
      - name: dataset
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Dataset
      - 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: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_QueryFetchAllPageResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get All Queries Query  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get All Queries Query  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/last_fetched_time:
    get:
      tags:
      - QUERIES
      summary: Get Last Fetch Time
      operationId: get_last_fetch_time_query_last_fetched_time_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Last Fetch Time Query Last Fetched Time Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Last Fetch Time Query Last Fetched Time Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Last Fetch Time Query Last Fetched Time Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/download:
    get:
      tags:
      - QUERIES
      summary: Download All Queries
      operationId: download_all_queries_query_download_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tags
      - name: warehouses
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouses
      - name: users
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Users
      - name: sortAttribute
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: query_cost
          title: Sortattribute
      - name: sortOrder
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sortorder
      - name: executionTimeFilter
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          default: 0
          title: Executiontimefilter
      - name: executionCostFilter
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          default: 0
          title: Executioncostfilter
      - name: query_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Hash
      - name: query_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Id
      - name: session_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session Id
      - name: query_parameterized_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Parameterized Hash
      - name: dataset
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Dataset
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Download All Queries Query Download Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Download All Queries Query Download Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/items/{query_id}:
    get:
      tags:
      - QUERIES
      summary: Get Query
      operationId: get_query_query_items__query_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          title: Query Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryFetchResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Query Query Items  Query Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Query Query Items  Query Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/filters/:
    get:
      tags:
      - QUERIES
      summary: Get All Filters
      operationId: get_all_filters_query_filters__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Hash
      - name: filter_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Filter Type
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryFiltersFetchAllResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get All Filters Query Filters  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get All Filters Query Filters  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/custom/{query_id}:
    post:
      tags:
      - QUERIES
      summary: Upsert Custom Query Tag
      operationId: upsert_custom_query_tag_query_custom__query_id__post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          title: Query Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryUpsertCustomTagRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUpsertCustomTagResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Upsert Custom Query Tag Query Custom  Query Id  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Upsert Custom Query Tag Query Custom  Query Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/groups:
    get:
      tags:
      - QUERIES
      summary: Get All Query Groups
      operationId: get_all_query_groups_query_groups_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: sort_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: annualized_cost
          title: Sort Key
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sort Order
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tags
      - name: users
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Users
      - name: warehouses
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouses
      - name: query_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Hash
      - 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: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_QueryGroupPageItem_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get All Query Groups Query Groups Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get All Query Groups Query Groups Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/groups/{query_hash}:
    get:
      tags:
      - QUERIES
      summary: Get Query Group Details
      operationId: get_query_group_details_query_groups__query_hash__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_hash
        in: path
        required: true
        schema:
          type: string
          title: Query Hash
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryGroupResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Query Group Details Query Groups  Query Hash  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Query Group Details Query Groups  Query Hash  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - QUERIES
      summary: Update Query Group Name
      operationId: update_query_group_name_query_groups__query_hash__patch
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_hash
        in: path
        required: true
        schema:
          type: string
          title: Query Hash
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueryGroupRequest'
      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 Update Query Group Name Query Groups  Query Hash  Patch
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Update Query Group Name Query Groups  Query Hash  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/groups/graph_data/{query_hash}:
    get:
      tags:
      - QUERIES
      summary: Graph Data Query Groups
      operationId: graph_data_query_groups_query_groups_graph_data__query_hash__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_hash
        in: path
        required: true
        schema:
          type: string
          title: Query Hash
      - name: period
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Period'
          default: 30
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryGraphDataResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Graph Data Query Groups Query Groups Graph Data  Query Hash  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Graph Data Query Groups Query Groups Graph Data  Query Hash  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/jobs/graph_data/{job_id}:
    get:
      tags:
      - QUERIES
      summary: Graph Data Query Jobs
      operationId: graph_data_query_jobs_query_jobs_graph_data__job_id__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: period
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Period'
          default: 30
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryGraphDataResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Graph Data Query Jobs Query Jobs Graph Data  Job Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Graph Data Query Jobs Query Jobs Graph Data  Job Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/download/groups:
    get:
      tags:
      - QUERIES
      summary: Download All Groups
      operationId: download_all_groups_query_download_groups_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: sort_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: annualized_cost
          title: Sort Key
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sort Order
      - name: tags
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Tags
      - name: users
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Users
      - name: warehouses
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouses
      - name: query_hash
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query Hash
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Download All Groups Query Download Groups Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Download All Groups Query Download Groups Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/jobs:
    get:
      tags:
      - QUERIES
      summary: Get All Jobs
      operationId: get_all_jobs_query_jobs_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: sort_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: annualized_cost
          title: Sort Key
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sort Order
      - name: annualized_cost
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          default: 0
          title: Annualized Cost
      - name: warehouses
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouses
      - name: job_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Job Id
      - name: auto_tune
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          default: false
          title: Auto Tune
      - name: environments
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Environments
      - 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: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_QueryJobProcessedResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get All Jobs Query Jobs Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get All Jobs Query Jobs Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query/jobs/executions/{job_id}:
    get:
      tags:
      - QUERIES
      summary: Get All Job Executions
      operationId: get_all_job_executions_query_jobs_executions__job_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: sort_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: timestamp
          title: Sort Key
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Sort Order
      - name: warehouses
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouses
      - name: users
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Users
      - name: executionCostFilter
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          default: 0
          title: Executioncostfilter
      - name: warehouse_sizes
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Warehouse Sizes
      - 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: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_QueryJobExecutionProcessedResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                typ

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