AnomalyArmor Row Count API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai Row Count API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged row-count across 3 of this provider''s published API definitions: anomalyarmor.ai-openapi.json, app.anomalyarmor.ai-openapi.json, docs.anomalyarmor.ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8000
  description: Development server
- url: https://api.anomalyarmor.ai
  description: Production server
tags:
- name: row-count
paths:
  /api/v1/assets/{asset_id}/row-count:
    get:
      tags:
      - row-count
      summary: Get Asset Row Count Overview
      description: 'Get row_count overview for an asset.


        Returns comprehensive row_count monitoring data including:

        - Summary statistics (healthy, warning, anomaly counts)

        - Individual schedule status (paginated)

        - Latest check results

        - Detected patterns'
      operationId: get_asset_row_count_overview_api_v1_assets__asset_id__row_count_get
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Asset Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Maximum schedules to return
          default: 20
          title: Limit
        description: Maximum schedules to return
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Number of schedules to skip
          default: 0
          title: Offset
        description: Number of schedules to skip
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/{asset_id}/row-count/schedules:
    post:
      tags:
      - row-count
      summary: Create Row Count Schedule
      description: 'Create row_count monitoring schedule for a table.


        Starts row count monitoring according to the specified time window

        and check interval.'
      operationId: create_row_count_schedule_api_v1_assets__asset_id__row_count_schedules_post
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Asset Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRowCountScheduleRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/row-count/schedules/{schedule_id}:
    patch:
      tags:
      - row-count
      summary: Update Row Count Schedule
      description: Update row_count monitoring schedule.
      operationId: update_row_count_schedule_api_v1_assets_row_count_schedules__schedule_id__patch
      parameters:
      - name: schedule_id
        in: path
        required: true
        schema:
          type: string
          title: Schedule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRowCountScheduleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - row-count
      summary: Delete Row Count Schedule
      description: Delete row_count monitoring schedule.
      operationId: delete_row_count_schedule_api_v1_assets_row_count_schedules__schedule_id__delete
      parameters:
      - name: schedule_id
        in: path
        required: true
        schema:
          type: string
          title: Schedule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/{asset_id}/row-count/{table_path}:
    get:
      tags:
      - row-count
      summary: Get Table Row Count Status
      description: 'Get row_count status for a specific table.


        Returns:

        - Schedule configuration

        - Latest check result

        - Detected pattern

        - Historical measurements'
      operationId: get_table_row_count_status_api_v1_assets__asset_id__row_count__table_path__get
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Asset Id
      - name: table_path
        in: path
        required: true
        schema:
          type: string
          title: Table Path
      - name: history_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 1
          description: Days of history to include
          default: 30
          title: History Days
        description: Days of history to include
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/{asset_id}/row-count/{table_path}/check:
    post:
      tags:
      - row-count
      summary: Trigger Row Count Check
      description: 'Trigger an immediate row_count check for a table.


        Queues a row_count check job and returns the job ID for polling.'
      operationId: trigger_row_count_check_api_v1_assets__asset_id__row_count__table_path__check_post
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Asset Id
      - name: table_path
        in: path
        required: true
        schema:
          type: string
          title: Table Path
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/{asset_id}/row-count/{table_path}/backfill:
    post:
      tags:
      - row-count
      summary: Trigger Row Count Backfill
      description: 'Trigger historical data backfill for a row count schedule.


        Uses the schedule''s timestamp column to query historical data from the

        customer''s database, creating synthetic history records to skip the

        learning phase.'
      operationId: trigger_row_count_backfill_api_v1_assets__asset_id__row_count__table_path__backfill_post
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Asset Id
      - name: table_path
        in: path
        required: true
        schema:
          type: string
          title: Table Path
      - name: lookback_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 7
          description: How far back to query
          default: 90
          title: Lookback Days
        description: How far back to query
      - name: granularity
        in: query
        required: false
        schema:
          type: string
          description: 'Bucket size: ''1h'', ''6h'', ''12h'', ''24h'', ''7d''. Empty = match schedule window.'
          default: ''
          title: Granularity
        description: 'Bucket size: ''1h'', ''6h'', ''12h'', ''24h'', ''7d''. Empty = match schedule window.'
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/row-count/schedules/{schedule_id}/history:
    get:
      tags:
      - row-count
      summary: Get Row Count History
      description: Get row_count check history for a schedule.
      operationId: get_row_count_history_api_v1_assets_row_count_schedules__schedule_id__history_get
      parameters:
      - name: schedule_id
        in: path
        required: true
        schema:
          type: string
          title: Schedule Id
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 1
          description: Days of history
          default: 30
          title: Days
        description: Days of history
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 10
          description: Maximum records
          default: 100
          title: Limit
        description: Maximum records
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Records to skip
          default: 0
          title: Offset
        description: Records to skip
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/assets/row-count/schedules/{schedule_id}/forecast:
    get:
      tags:
      - row-count
      summary: Get Row Count Forecast
      description: 'Get forecast for future periods based on learned pattern.


        TECH-749: Prediction visualization for row_count charts.


        Returns forecast data points that can be displayed alongside historical data

        to show predicted future row counts with confidence bounds.


        The forecast is generated from existing learned patterns and does not require

        additional computation. Bounds widen further into the future to reflect

        growing uncertainty.


        Returns empty forecasts with reason if:

        - Pattern has not been learned yet (reason: "no_pattern")

        - Pattern confidence is below 70% (reason: "insufficient_confidence")

        - Schedule not found (reason: "schedule_not_found")'
      operationId: get_row_count_forecast_api_v1_assets_row_count_schedules__schedule_id__forecast_get
      parameters:
      - name: schedule_id
        in: path
        required: true
        schema:
          type: string
          title: Schedule Id
      - name: periods
        in: query
        required: false
        schema:
          type: integer
          maximum: 7
          minimum: 1
          description: Number of future periods to forecast
          default: 3
          title: Periods
        description: Number of future periods to forecast
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
components:
  schemas:
    UpdateRowCountScheduleRequest:
      properties:
        timestamp_column:
          anyOf:
          - type: string
          - type: 'null'
          title: Timestamp Column
          description: Column to filter rows by time period
        time_window_hours:
          anyOf:
          - type: integer
            enum:
            - 1
            - 6
            - 12
            - 24
            - 168
          - type: 'null'
          title: Time Window Hours
          description: Time window for row count measurement
        check_interval:
          anyOf:
          - type: string
          - type: 'null'
          title: Check Interval
          description: Check interval (e.g., '1h', '6h', '1d')
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
          description: Enable/disable monitoring
        monitoring_mode:
          anyOf:
          - type: string
            enum:
            - auto_learn
            - explicit
          - type: 'null'
          title: Monitoring Mode
          description: 'Monitoring mode: ''auto_learn'' or ''explicit'''
        expected_min_rows:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Expected Min Rows
          description: 'For explicit mode: minimum expected rows'
        expected_max_rows:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Expected Max Rows
          description: 'For explicit mode: maximum expected rows'
        sensitivity:
          anyOf:
          - type: integer
            maximum: 4.0
            minimum: 1.0
          - type: 'null'
          title: Sensitivity
          description: Sensitivity level (1-4)
        operating_period_mode:
          anyOf:
          - type: string
          - type: 'null'
          title: Operating Period Mode
          description: 'Operating-period awareness (TECH-984): ''off'', ''auto'', or ''schedule'''
        operating_schedule_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Operating Schedule Id
          description: Operating schedule public UUID ('schedule' mode)
      type: object
      title: UpdateRowCountScheduleRequest
      description: Request to update row_count monitoring schedule.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateRowCountScheduleRequest:
      properties:
        table_path:
          type: string
          title: Table Path
          description: Table path (schema.table_name)
        timestamp_column:
          anyOf:
          - type: string
          - type: 'null'
          title: Timestamp Column
          description: Column to filter rows by time period. If NULL, counts all rows.
        time_window_hours:
          type: integer
          enum:
          - 1
          - 6
          - 12
          - 24
          - 168
          title: Time Window Hours
          description: Time window for row count measurement (1, 6, 12, 24, or 168 hours)
          default: 24
        check_interval:
          type: string
          title: Check Interval
          description: Check interval (e.g., '1h', '6h', '1d')
          default: 1h
        monitoring_mode:
          type: string
          enum:
          - auto_learn
          - explicit
          title: Monitoring Mode
          description: 'Monitoring mode: ''auto_learn'' for ML-based or ''explicit'' for manual thresholds'
          default: auto_learn
        expected_min_rows:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Expected Min Rows
          description: 'For explicit mode: alert when row count falls below this value'
        expected_max_rows:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Expected Max Rows
          description: 'For explicit mode: optional upper bound for alerting'
        sensitivity:
          type: integer
          maximum: 4.0
          minimum: 1.0
          title: Sensitivity
          description: 'Sensitivity (1-4): 1=tight (more alerts), 4=loose (fewer alerts)'
          default: 2
        freshness_schedule_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Freshness Schedule Id
          description: Optional link to freshness schedule UUID (for auto-creation)
        operating_period_mode:
          type: string
          title: Operating Period Mode
          description: 'Operating-period awareness (TECH-984): ''off'', ''auto'', or ''schedule'' (segments the baseline by the linked operating schedule)'
          default: 'off'
        operating_schedule_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Operating Schedule Id
          description: Operating schedule public UUID, required when operating_period_mode is 'schedule'
      type: object
      required:
      - table_path
      title: CreateRowCountScheduleRequest
      description: Request to create row_count monitoring schedule.
    StandardResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - {}
          - type: 'null'
          title: Data
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: StandardResponse
      description: Standard API response wrapper.
    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
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json