Altimate AI EVENTS API

openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS EVENTS API
  version: 0.1.0
tags:
- name: EVENTS
paths:
  /events/:
    get:
      tags:
      - EVENTS
      summary: Fetch Timeline Events
      description: 'Fetches all timeline_events.

        :param auth: The authorization token for the request.

        :param db: The database session to use for fetching the timeline_events.

        :return: A dictionary containing the result of the operation.'
      operationId: fetch_timeline_events_events__get
      deprecated: true
      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:
                $ref: '#/components/schemas/TimelineEventFetchAllResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Fetch Timeline Events Events  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Fetch Timeline Events Events  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/{contract_id}:
    get:
      tags:
      - EVENTS
      summary: Fetch Timeline Events By Contract Id
      description: 'Fetches all timeline_events for a given contract.

        :param auth: The authorization token for the request.

        :param db: The database session to use for fetching the timeline_events.

        :param contract_id: The contract for which wer are supposed to fetch timeline_events.

        :return: A dictionary containing the result of the operation.'
      operationId: fetch_timeline_events_by_contract_id_events__contract_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          type: integer
          title: Contract 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/TimelineEventFetchAllResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Fetch Timeline Events By Contract Id Events  Contract Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Fetch Timeline Events By Contract Id Events  Contract Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/validations/:
    get:
      tags:
      - EVENTS
      summary: Fetch Validation Events
      description: 'Fetches all validation_events for all contracts.

        :param auth: The authorization token for the request.

        :param db: The database session to use for fetching the validation_events.

        :return: A dictionary containing the result of the operation.'
      operationId: fetch_validation_events_events_validations__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: contracts
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: integer
          - type: 'null'
          title: Contracts
      - name: timestamp
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Timestamp
      - name: validation_status
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Validation Status
      - 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_ValidationEventsFetchPageResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Fetch Validation Events Events Validations  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Fetch Validation Events Events Validations  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/validations/{contract_id}:
    get:
      tags:
      - EVENTS
      summary: Fetch Validation Events By Contract Id
      description: 'Fetches all validation_events for a given contract.

        :param auth: The authorization token for the request.

        :param db: The database session to use for fetching the validation_events.

        :param contract_id: The contract for which wer are supposed to fetch validation_events.

        :return: A dictionary containing the result of the operation.'
      operationId: fetch_validation_events_by_contract_id_events_validations__contract_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          type: integer
          title: Contract 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/ValidationEventFetchAllResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Fetch Validation Events By Contract Id Events Validations  Contract Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Fetch Validation Events By Contract Id Events Validations  Contract Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/sync_history/{data_store_id}:
    get:
      tags:
      - EVENTS
      summary: Get Sync History
      description: Get sync history for a datastore by id
      operationId: get_sync_history_events_sync_history__data_store_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: data_store_id
        in: path
        required: true
        schema:
          type: integer
          title: Data Store Id
      - name: status
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/SyncStatus'
          default: []
          title: Status
      - 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_SyncHistoryFetchResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Sync History Events Sync History  Data Store Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Sync History Events Sync History  Data Store Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/execution_history/:
    get:
      tags:
      - EVENTS
      summary: Get Execution History
      operationId: get_execution_history_events_execution_history__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: all_time
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: All Time
      - 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/ExecutionHistoryResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Execution History Events Execution History  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Execution History Events Execution History  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/analytics_history/:
    get:
      tags:
      - EVENTS
      summary: Get Analytics History
      operationId: get_analytics_history_events_analytics_history__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: period
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/ExecutionAnalyticsPeriods'
      - 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/AnalyticsHistoryResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Analytics History Events Analytics History  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Analytics History Events Analytics History  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/alerts/:
    get:
      tags:
      - EVENTS
      summary: Fetch Alert Events By Alert Id
      description: 'Fetches all alert_events for a given alert id.

        :param auth: The authorization token for the request.

        :param db: The database session to use for fetching the alert_events.

        :param alert_id: The (optional) alert id for which we are supposed to fetch alert_events.

        :return: A dictionary containing the result of the operation.'
      operationId: fetch_alert_events_by_alert_id_events_alerts__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: alert_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Alert Id
      - name: timestamp
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Timestamp
      - name: sortColumn
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sortcolumn
      - name: sortOrder
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sortorder
      - 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_AlertEventsFetchPageResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Fetch Alert Events By Alert Id Events Alerts  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Fetch Alert Events By Alert Id Events Alerts  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events/credit_details/:
    get:
      tags:
      - EVENTS
      summary: Get Credit Details
      operationId: get_credit_details_events_credit_details__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: all_time
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: All Time
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventDetail'
                title: Response Get Credit Details Events Credit Details  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Credit Details Events Credit Details  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Credit Details Events Credit Details  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Alert:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        threshold:
          anyOf:
          - type: number
          - type: 'null'
          title: Threshold
      type: object
      title: Alert
    SyncStatus:
      type: string
      enum:
      - success
      - running
      - failed
      title: SyncStatus
    ValidationEventFetchAllResponse:
      properties:
        validation_events:
          items:
            $ref: '#/components/schemas/ValidationEventFetchResponse'
          type: array
          title: Validation Events
      type: object
      required:
      - validation_events
      title: ValidationEventFetchAllResponse
    ContractResource:
      properties:
        resource:
          $ref: '#/components/schemas/app__schemas__events__Resource'
        alias:
          type: string
          title: Alias
      type: object
      required:
      - resource
      - alias
      title: ContractResource
    Page_SyncHistoryFetchResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SyncHistoryFetchResponse'
          type: array
          title: Items
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
        page:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Page
        size:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Size
        pages:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Pages
      type: object
      required:
      - items
      - total
      - page
      - size
      title: Page[SyncHistoryFetchResponse]
    Page_ValidationEventsFetchPageResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ValidationEventsFetchPageResponse'
          type: array
          title: Items
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
        page:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Page
        size:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Size
        pages:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Pages
      type: object
      required:
      - items
      - total
      - page
      - size
      title: Page[ValidationEventsFetchPageResponse]
    TimelineEventFetchAllResponse:
      properties:
        timeline_events:
          items:
            $ref: '#/components/schemas/TimelineEventFetchResponse'
          type: array
          title: Timeline Events
      type: object
      required:
      - timeline_events
      title: TimelineEventFetchAllResponse
    AnalyticsHistoryResponse:
      properties:
        analytics_history:
          items:
            $ref: '#/components/schemas/AnalyticsHistory'
          type: array
          title: Analytics History
        show_usage_trend:
          type: boolean
          title: Show Usage Trend
        execution_history_by_user:
          items:
            $ref: '#/components/schemas/ExecutionHistoryByUser'
          type: array
          title: Execution History By User
        total_executions:
          type: integer
          title: Total Executions
        time_saved_avg_hrs:
          type: number
          title: Time Saved Avg Hrs
        total_time_saved_hrs:
          type: number
          title: Total Time Saved Hrs
        total_time_saved_str:
          type: string
          title: Total Time Saved Str
        month:
          type: string
          title: Month
        start_date:
          type: string
          title: Start Date
      type: object
      required:
      - analytics_history
      - show_usage_trend
      - execution_history_by_user
      - total_executions
      - time_saved_avg_hrs
      - total_time_saved_hrs
      - total_time_saved_str
      - month
      - start_date
      title: AnalyticsHistoryResponse
    ExecutionsNameValue:
      properties:
        name:
          type: string
          title: Name
        count:
          type: integer
          title: Count
          default: 0
        value:
          type: integer
          title: Value
          default: 0
        value_charged:
          type: integer
          title: Value Charged
          default: 0
      type: object
      required:
      - name
      title: ExecutionsNameValue
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationEventFetchResponse:
      properties:
        id:
          type: integer
          title: Id
        contract_id:
          type: integer
          title: Contract Id
        validation_status:
          type: string
          title: Validation Status
        number_of_violations:
          type: integer
          title: Number Of Violations
        validated_on:
          type: string
          format: date-time
          title: Validated On
      type: object
      required:
      - id
      - contract_id
      - validation_status
      - number_of_violations
      - validated_on
      title: ValidationEventFetchResponse
    TimelineEventFetchResponse:
      properties:
        id:
          type: integer
          title: Id
        contract_id:
          type: integer
          title: Contract Id
        event_type:
          type: string
          title: Event Type
        event_message:
          type: string
          title: Event Message
        user_first_name:
          type: string
          title: User First Name
        user_last_name:
          type: string
          title: User Last Name
        user_email:
          type: string
          title: User Email
        created_on:
          type: string
          format: date-time
          title: Created On
      type: object
      required:
      - id
      - contract_id
      - event_type
      - event_message
      - user_first_name
      - user_last_name
      - user_email
      - created_on
      title: TimelineEventFetchResponse
    EventDetail:
      properties:
        timestamp:
          type: string
          format: date-time
          title: Timestamp
        user_email:
          type: string
          title: User Email
        feature_name:
          type: string
          title: Feature Name
        num_credits:
          type: number
          title: Num Credits
      type: object
      required:
      - timestamp
      - user_email
      - feature_name
      - num_credits
      title: EventDetail
    SyncHistoryFetchResponse:
      properties:
        id:
          type: integer
          title: Id
        event_id:
          type: integer
          title: Event Id
        sync_status:
          type: string
          title: Sync Status
        sync_event_type:
          type: string
          title: Sync Event Type
        created_on:
          type: string
          format: date-time
          title: Created On
        site_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Site Name
      type: object
      required:
      - id
      - event_id
      - sync_status
      - sync_event_type
      - created_on
      title: SyncHistoryFetchResponse
    Contract:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        schedule:
          type: string
          title: Schedule
        contract_resources:
          items:
            $ref: '#/components/schemas/ContractResource'
          type: array
          title: Contract Resources
        data_store:
          $ref: '#/components/schemas/DataStore'
      type: object
      required:
      - id
      - name
      - schedule
      - contract_resources
      - data_store
      title: Contract
    ExecutionHistoryByUser:
      properties:
        user_id:
          type: integer
          title: User Id
        executions:
          type: integer
          title: Executions
        display_name:
          type: string
          title: Display Name
        percentage_executions:
          type: number
          title: Percentage Executions
      type: object
      required:
      - user_id
      - executions
      - display_name
      - percentage_executions
      title: ExecutionHistoryByUser
    AlertEventsFetchPageResponse:
      properties:
        id:
          type: integer
          title: Id
        alert_id:
          type: integer
          title: Alert Id
        event_id:
          type: integer
          title: Event Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        attributes:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Attributes
        value:
          type: number
          title: Value
        message:
          type: string
          title: Message
        status:
          type: string
          title: Status
        alert:
          $ref: '#/components/schemas/Alert'
      type: object
      required:
      - id
      - alert_id
      - event_id
      - created_at
      - updated_at
      - value
      - message
      - status
      - alert
      title: AlertEventsFetchPageResponse
    app__schemas__events__Resource:
      properties:
        identifier:
          type: string
          title: Identifier
        id:
          type: integer
          title: Id
      type: object
      required:
      - identifier
      - id
      title: Resource
    Table:
      properties:
        resource_id:
          type: integer
          title: Resource Id
        database:
          type: string
          title: Database
        schema:
          type: string
          title: Schema
          default: 1
        alias:
          type: string
          title: Alias
        tablename:
          type: string
          title: Tablename
        path:
          type: string
          title: Path
      type: object
      required:
      - resource_id
      - database
      - alias
      - tablename
      - path
      title: Table
    AnalyticsHistory:
      properties:
        day:
          anyOf:
          - type: string
          - type: integer
          title: Day
        executions:
          type: integer
          title: Executions
      type: object
      required:
      - day
      - executions
      title: AnalyticsHistory
    ExecutionAnalyticsPeriods:
      type: string
      enum:
      - week
      - month
      - all_time
      title: ExecutionAnalyticsPeriods
    Page_AlertEventsFetchPageResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AlertEventsFetchPageResponse'
          type: array
          title: Items
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
        page:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Page
        size:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Size
        pages:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Pages
      type: object
      required:
      - items
      - total
      - page
      - size
      title: Page[AlertEventsFetchPageResponse]
    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
    ExecutionHistoryResponse:
      properties:
        execution:
          items:
            $ref: '#/components/schemas/ExecutionsNameValue'
          type: array
          title: Execution
        start_date:
          type: string
          title: Start Date
      type: object
      required:
      - execution
      - start_date
      title: ExecutionHistoryResponse
    ValidationEventsFetchPageResponse:
      properties:
        id:
          type: integer
          title: Id
        event_id:
          type: integer
          title: Event Id
        validation_status:
          type: string
          title: Validation Status
        number_of_violations:
          type: integer
          title: Number Of Violations
        validated_on:
          type: string
          format: date-time
          title: Validated On
        contract:
          $ref: '#/components/schemas/Contract'
        tables:
          anyOf:
          - items:
              $ref: '#/components/schemas/Table'
            type: array
          - type: 'null'
          title: Tables
      type: object
      required:
      - id
      - event_id
      - validation_status
      - number_of_violations
      - validated_on
      - contract
      title: ValidationEventsFetchPageResponse
    DataStore:
      properties:
        name:
          type: string
          title: Name
        type:
          type: string
          title: Type
      type: object
      required:
      - name
      - type
      title: DataStore
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer