Bigeye

Bigeye Comparison Table Service API

The ComparisonTableService API from Bigeye — 6 operation(s) for comparisontableservice.

Documentation GitHub OpenAPI

Operations 7

POST /api/v1/metrics/comparisons/tables Create a comparison table #

DELETE /api/v1/metrics/comparisons/tables/{comparisonTableId} Delete a comparison table #

GET /api/v1/metrics/comparisons/tables/{comparisonTableId} Retrieve a comparison table configuration #

POST /api/v1/metrics/comparisons/tables/info Get information about comparison tables #

GET /api/v1/tables/{tableId}/delta-applicable-metric-types Get list of metrics applicable for comparison tables and deltas #

GET /api/v1/metrics/comparisons/metrics/{comparisonMetricId}/groups/info Get info about the groups of a particular metric in a comparison table #

GET /api/v1/metrics/comparisons/tables/run/{comparisonTableId} Run a comparison table #

Documentation

📖

Documentation

https://docs.bigeye.com/docs/api-user-guide

📖

APIReference

https://docs.bigeye.com/reference

📖

Documentation

https://docs.bigeye.com/docs/monitoring

📖

Documentation

https://docs.bigeye.com/docs/getting-started-scanning

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-comparisontableservice-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bigeye-comparisontableservice-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Observability Comparison Table Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: ComparisonTableService
paths:
  /api/v1/metrics/comparisons/tables:
    post:
      operationId: ComparisonTableService_CreateComparisonTable
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedCreateComparisonTableRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedCreateComparisonTableResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Create a comparison table
      tags:
      - ComparisonTableService
  /api/v1/metrics/comparisons/tables/{comparisonTableId}:
    delete:
      operationId: ComparisonTableService_DeleteComparisonTable
      parameters:
      - in: path
        name: comparisonTableId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedEmpty'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Delete a comparison table
      tags:
      - ComparisonTableService
    get:
      operationId: ComparisonTableService_GetComparisonTable
      parameters:
      - in: path
        name: comparisonTableId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetComparisonTableResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Retrieve a comparison table configuration
      tags:
      - ComparisonTableService
  /api/v1/metrics/comparisons/tables/info:
    post:
      operationId: ComparisonTableService_GetComparisonTableInfos
      requestBody:
        $ref: '#/components/requestBodies/generatedGetComparisonTableInfosRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetComparisonTableInfosResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get information about comparison tables
      tags:
      - ComparisonTableService
  /api/v1/tables/{tableId}/delta-applicable-metric-types:
    get:
      operationId: ComparisonTableService_GetDeltaApplicableMetricTypes
      parameters:
      - in: path
        name: tableId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetDeltaApplicableMetricTypesResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get list of metrics applicable for comparison tables and deltas
      tags:
      - ComparisonTableService
  /api/v1/metrics/comparisons/metrics/{comparisonMetricId}/groups/info:
    get:
      operationId: ComparisonTableService_GetTableComparisonMetricGroupInfo
      parameters:
      - in: path
        name: comparisonMetricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetTableComparisonMetricGroupInfoResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get info about the groups of a particular metric in a comparison table
      tags:
      - ComparisonTableService
  /api/v1/metrics/comparisons/tables/run/{comparisonTableId}:
    get:
      operationId: ComparisonTableService_RunComparisonTable
      parameters:
      - in: path
        name: comparisonTableId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedRunComparisonTableResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Run a comparison table
      tags:
      - ComparisonTableService
components:
  schemas:
    generatedComparisonMetricStatus:
      enum:
      - COMPARISON_METRIC_STATUS_UNKNOWN
      - COMPARISON_METRIC_STATUS_OK
      - COMPARISON_METRIC_STATUS_ALERT
      - COMPARISON_METRIC_STATUS_OK_NO_RUNS
      type: string
    generatedIdAndDisplayName:
      properties:
        displayName:
          type: string
        id:
          format: int32
          type: integer
      type: object
    generatedMetricConfiguration:
      properties:
        alertOnAbsentGroups:
          type: boolean
        bigconfigNamespace:
          type: string
        customRuleId:
          format: int32
          type: integer
        datasetId:
          format: int32
          title: Bigeye ID for the table which this metric is run on
          type: integer
        description:
          type: string
        dimension:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        filters:
          items:
            type: string
          title: Each filter evaluates to a valid SQL boolean expression
          type: array
        grainSeconds:
          format: int32
          title: width of METRIC_TIME based metric intervals
          type: integer
        groupBys:
          items:
            type: string
          title: Each group by is a column name from the table for this metric
          type: array
        id:
          format: int32
          type: integer
        isLookbackUsingCurrentTime:
          type: boolean
        isTableMetric:
          type: boolean
        lookback:
          $ref: '#/components/schemas/generatedTimeInterval'
        lookbackType:
          $ref: '#/components/schemas/generatedLookbackType'
        metricCreationState:
          $ref: '#/components/schemas/generatedMetricCreationState'
        metricGroupOverrides:
          items:
            $ref: '#/components/schemas/generatedMetricGroupOverride'
          type: array
        metricObservedColumnResponse:
          items:
            $ref: '#/components/schemas/generatedMetricObservedColumnResponse'
          type: array
        metricSchedule:
          $ref: '#/components/schemas/generatedMetricSchedule'
        metricType:
          $ref: '#/components/schemas/generatedMetricType'
        monitorType:
          $ref: '#/components/schemas/generatedMonitorType'
        mutedUntilEpochSeconds:
          format: int64
          type: string
        name:
          type: string
        notificationChannels:
          items:
            $ref: '#/components/schemas/generatedNotificationChannel'
          type: array
        parameters:
          items:
            $ref: '#/components/schemas/generatedMetricParameter'
          type: array
        profilingSuggestionForColumn:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        rctOverride:
          type: string
        scheduleFrequency:
          $ref: '#/components/schemas/generatedTimeInterval'
        thresholds:
          items:
            $ref: '#/components/schemas/generatedThreshold'
          type: array
        warehouseId:
          format: int32
          type: integer
      type: object
    generatedGetComparisonTableInfosResponse:
      properties:
        comparisonTableInfos:
          items:
            $ref: '#/components/schemas/generatedComparisonTableInfo'
          type: array
        paginationInfo:
          $ref: '#/components/schemas/generatedPaginationInfo'
      type: object
    generatedPaginationInfo:
      properties:
        firstSortDistinctValues:
          format: int64
          type: string
        nextCursor:
          type: string
        noNumRecords:
          type: boolean
        numRecords:
          format: int32
          type: integer
        prevCursor:
          type: string
      type: object
    generatedForecastModelType:
      default: UNDEFINED_THRESHOLD_MODEL_TYPE
      enum:
      - UNDEFINED_THRESHOLD_MODEL_TYPE
      type: string
    generatedFreshnessScheduleThreshold:
      properties:
        bound:
          $ref: '#/components/schemas/generatedSimpleBound'
        cron:
          type: string
        delayAtUpdate:
          $ref: '#/components/schemas/generatedTimeInterval'
        timezone:
          type: string
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedComparisonMetricGroup:
      properties:
        difference:
          format: double
          type: number
        dimensions:
          items:
            $ref: '#/components/schemas/generatedMetricGroupDimension'
          type: array
        sourceValue:
          format: double
          type: number
        status:
          $ref: '#/components/schemas/generatedComparisonMetricStatus'
        targetValue:
          format: double
          type: number
      type: object
    generatedComparisonTableSortField:
      default: COMPARISON_TABLE_SORT_FIELD_UNSPECIFIED
      enum:
      - COMPARISON_TABLE_SORT_FIELD_UNSPECIFIED
      - COMPARISON_TABLE_SORT_FIELD_RAN_AT
      - COMPARISON_TABLE_SORT_FIELD_NAME
      - COMPARISON_TABLE_SORT_FIELD_FAVORITE
      type: string
    generatedWebhookHeader:
      properties:
        key:
          type: string
        value:
          type: string
      type: object
    generatedSlackChannelInfo:
      properties:
        channelId:
          type: string
        channelName:
          type: string
        issueThreadPermalink:
          type: string
        threadTs:
          type: string
      type: object
    generatedSimpleBoundType:
      default: UNDEFINED_SIMPLE_BOUND_TYPE
      enum:
      - UNDEFINED_SIMPLE_BOUND_TYPE
      - LOWER_BOUND_SIMPLE_BOUND_TYPE
      - UPPER_BOUND_SIMPLE_BOUND_TYPE
      type: string
    generatedTableColumn:
      description: '*

        Representation of a column in a table.'
      properties:
        canBeMetricTime:
          type: boolean
        dataNodeId:
          format: int32
          type: integer
        extendedType:
          type: string
        fullType:
          type: string
        id:
          format: int32
          type: integer
        isFavorite:
          type: boolean
        isKeyInJoin:
          type: boolean
        isMetricTime:
          type: boolean
        isNullable:
          type: boolean
        isPartitionField:
          type: boolean
        name:
          type: string
        parentColumnId:
          format: int32
          type: integer
        schemaChangeInfo:
          $ref: '#/components/schemas/generatedSchemaChangeInfo'
        tags:
          items:
            $ref: '#/components/schemas/generatedTag'
          type: array
        type:
          type: string
      type: object
    generatedTemplateMetric:
      properties:
        aggregationType:
          $ref: '#/components/schemas/generatedAggregationType'
        templateId:
          format: int32
          type: integer
        templateName:
          type: string
      type: object
    generatedColumnNamePair:
      properties:
        sourceColumnName:
          type: string
        targetColumnName:
          type: string
      type: object
    generatedTag:
      properties:
        colorHex:
          title: 'color_hex includes a # prefix (e.g. “#181818” is correct, “181818” is incorrect)'
          type: string
        createdAt:
          format: int64
          type: string
        id:
          format: int32
          type: integer
        name:
          type: string
        updatedAt:
          format: int64
          type: string
        workspaceId:
          format: int32
          type: integer
      title: Tags
      type: object
    generatedCatalogEntityType:
      default: CATALOG_ENTITY_TYPE_UNSPECIFIED
      enum:
      - CATALOG_ENTITY_TYPE_UNSPECIFIED
      - CATALOG_ENTITY_TYPE_SOURCE
      - CATALOG_ENTITY_TYPE_SCHEMA
      - CATALOG_ENTITY_TYPE_DATASET
      - CATALOG_ENTITY_TYPE_FIELD
      - CATALOG_ENTITY_TYPE_DATA_NODE_ENTITY
      - CATALOG_ENTITY_TYPE_META_CENTER_ENTITY
      type: string
    generatedAutothresholdSensitivity:
      default: AUTOTHRESHOLD_SENSITIVITY_UNSPECIFIED
      enum:
      - AUTOTHRESHOLD_SENSITIVITY_UNSPECIFIED
      - AUTOTHRESHOLD_SENSITIVITY_NARROW
      - AUTOTHRESHOLD_SENSITIVITY_MEDIUM
      - AUTOTHRESHOLD_SENSITIVITY_WIDE
      - AUTOTHRESHOLD_SENSITIVITY_XWIDE
      type: string
    generatedLookbackType:
      default: UNDEFINED_LOOKBACK_TYPE
      enum:
      - UNDEFINED_LOOKBACK_TYPE
      - DATA_TIME_LOOKBACK_TYPE
      - CLOCK_TIME_LOOKBACK_TYPE
      - METRIC_TIME_LOOKBACK_TYPE
      type: string
    generatedMetricInfo:
      properties:
        activeIssue:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        canBackfill:
          type: boolean
        collections:
          items:
            $ref: '#/components/schemas/generatedIdAndDisplayName'
          type: array
        criticalGroupCount:
          format: int32
          type: integer
        groupCount:
          format: int32
          type: integer
        isBackfillDestructive:
          type: boolean
        isSnoozed:
          type: boolean
        latestMetricRuns:
          items:
            $ref: '#/components/schemas/generatedMetricRun'
          title: Latest metric run results
          type: array
        metricConfiguration:
          $ref: '#/components/schemas/generatedMetricConfiguration'
        metricMetadata:
          $ref: '#/components/schemas/generatedMetricMetadata'
        noValueGroupCount:
          format: int32
          type: integer
        reasonCannotBackfill:
          type: string
        status:
          $ref: '#/components/schemas/generatedMetricRunStatus'
        tags:
          items:
            $ref: '#/components/schemas/generatedTag'
          type: array
      type: object
    generatedMetricGroupOverride:
      properties:
        groupDimensions:
          items:
            $ref: '#/components/schemas/generatedMetricGroupDimension'
          type: array
        groupName:
          type: string
        thresholds:
          items:
            $ref: '#/components/schemas/generatedThreshold'
          type: array
      type: object
    generatedGetComparisonTableInfosRequest:
      properties:
        comparisonTableIds:
          items:
            format: int32
            type: integer
          type: array
        dimensionIds:
          items:
            format: int32
            type: integer
          type: array
        excludeComparisonMetrics:
          type: boolean
        pageCursor:
          type: string
        pageSize:
          format: int32
          type: integer
        search:
          type: string
        sortDirection:
          $ref: '#/components/schemas/generatedSortDirection'
        sortField:
          $ref: '#/components/schemas/generatedComparisonTableSortField'
        tagIds:
          items:
            format: int32
            type: integer
          type: array
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedComparisonMetricInfo:
      properties:
        comparisonMetricConfiguration:
          $ref: '#/components/schemas/generatedComparisonMetricConfiguration'
        criticalGroupCount:
          format: int32
          type: integer
        difference:
          format: double
          type: number
        exceptionClass:
          type: string
        exceptionMessage:
          type: string
        failedGroupCount:
          format: int32
          type: integer
        groupCount:
          format: int32
          type: integer
        sourceFailed:
          type: boolean
        sourceMetricInfo:
          $ref: '#/components/schemas/generatedMetricInfo'
        sourceValue:
          format: double
          type: number
        status:
          $ref: '#/components/schemas/generatedComparisonMetricStatus'
        targetFailed:
          type: boolean
        targetMetricInfo:
          $ref: '#/components/schemas/generatedMetricInfo'
        targetValue:
          format: double
          type: number
      type: object
    generatedMetricCreationState:
      default: METRIC_CREATION_STATE_UNSPECIFIED
      enum:
      - METRIC_CREATION_STATE_UNSPECIFIED
      - METRIC_CREATION_STATE_MANUAL
      - METRIC_CREATION_STATE_SUGGESTED_AUTO
      - METRIC_CREATION_STATE_ACCEPTED_AUTO
      - METRIC_CREATION_STATE_REJECTED_AUTO
      - METRIC_CREATION_STATE_COMPARISON
      - METRIC_CREATION_STATE_AUTOMATIC_SETUP
      - METRIC_CREATION_STATE_SUITE
      - METRIC_CREATION_STATE_CUSTOM_RULE
      - METRIC_CREATION_STATE_INTEGRATION
      type: string
    generatedCreateComparisonTableRequest:
      properties:
        comparisonTableConfiguration:
          $ref: '#/components/schemas/generatedComparisonTableConfiguration'
      type: object
    generatedJoin:
      properties:
        entityInfo:
          $ref: '#/components/schemas/generatedEntityInfo'
        id:
          format: int32
          type: integer
        keyColumns:
          items:
            $ref: '#/components/schemas/generatedJoinColumnPairing'
          type: array
        leftFilter:
          $ref: '#/components/schemas/generatedJoinTableFilter'
        leftTable:
          $ref: '#/components/schemas/generatedTable'
        rightFilter:
          $ref: '#/components/schemas/generatedJoinTableFilter'
        rightTable:
          $ref: '#/components/schemas/generatedTable'
      type: object
    generatedComparisonTableConfiguration:
      properties:
        columnMappings:
          items:
            $ref: '#/components/schemas/generatedComparisonColumnMapping'
          type: array
        entityInfo:
          $ref: '#/components/schemas/generatedEntityInfo'
        groupBys:
          items:
            $ref: '#/components/schemas/generatedColumnNamePair'
          type: array
        id:
          format: int32
          type: integer
        name:
          type: string
        namedSchedule:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        sourceFilters:
          items:
            type: string
          type: array
        sourceTableId:
          format: int32
          type: integer
        targetFilters:
          items:
            type: string
          type: array
        targetSchema:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        targetTable:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        targetTableId:
          format: int32
          type: integer
        tolerance:
          format: double
          type: number
      type: object
    generatedRunComparisonTableResponse:
      properties:
        comparisonTableInfo:
          $ref: '#/components/schemas/generatedComparisonTableInfo'
      type: object
    generatedConstantThreshold:
      properties:
        bound:
          $ref: '#/components/schemas/generatedSimpleBound'
      type: object
    generatedMetricMetadata:
      properties:
        companionMetrics:
          items:
            $ref: '#/components/schemas/generatedCompanionMetric'
          type: array
        createdAt:
          format: int64
          type: string
        currentMetricStatus:
          $ref: '#/components/schemas/generatedMetricStatus'
        datasetId:
          format: int32
          type: integer
        datasetName:
          type: string
        datasetTimeColumnName:
          type: string
        deletedAt:
          format: int64
          type: string
        fieldId:
          format: int32
          type: integer
        fieldName:
          type: string
        isFavorite:
          type: boolean
        metricHistoryBeginAt:
          format: int64
          type: string
        metricHistoryEndAt:
          format: int64
          type: string
        monitoredObjects:
          items:
            $ref: '#/components/schemas/generatedMonitoredObject'
          type: array
        runAt:
          format: int64
          type: string
        schemaId:
          format: int32
          type: integer
        schemaName:
          type: string
        statisticFullName:
          type: string
        statisticName:
          type: string
        updatedAt:
          format: int64
          type: string
        warehouseId:
          format: int32
          type: integer
        warehouseName:
          type: string
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedComparisonTableInfo:
      properties:
        alertingMetricCount:
          format: int64
          type: string
        comparisonMetricInfos:
          items:
            $ref: '#/components/schemas/generatedComparisonMetricInfo'
          type: array
        comparisonTableConfiguration:
          $ref: '#/components/schemas/generatedComparisonTableConfiguration'
        failedMetricCount:
          format: int64
          type: string
        isFavorite:
          type: boolean
        lastRunAtEpochSeconds:
          format: int64
          type: string
        metricCount:
          format: int64
          type: string
        nextRunEpochSeconds:
          format: int64
          type: string
        schemaMatch:
          type: boolean
        sourceRowCount:
          format: double
          type: number
        targetRowCount:
          format: double
          type: number
      type: object
    generatedJoinType:
      default: JOIN_TYPE_UNSPECIFIED
      enum:
      - JOIN_TYPE_UNSPECIFIED
      - JOIN_TYPE_INNER
      - JOIN_TYPE_LEFT
      - JOIN_TYPE_RIGHT
      - JOIN_TYPE_FULL
      type: string
    generatedAggregationType:
      default: UNDEFINED_AGGREGATION_TYPE
      enum:
      - UNDEFINED_AGGREGATION_TYPE
      - COUNT_AGGREGATION_TYPE
      - PERCENT_AGGREGATION_TYPE
      - MIN_AGGREGATION_TYPE
      - MAX_AGGREGATION_TYPE
      - AVG_AGGREGATION_TYPE
      - SUM_AGGREGATION_TYPE
      type: string
    generatedComparisonColumnMapping:
      properties:
        isPartOfKey:
          type: boolean
        metrics:
          items:
            $ref: '#/components/schemas/generatedMetricType'
          type: array
        sourceColumn:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        targetColumn:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        userDefined:
          type: boolean
      type: object
    generatedMetricRun:
      properties:
        exceptionClass:
          type: string
        exceptionMessage:
          type: string
        failureReason:
          $ref: '#/components/schemas/generatedMetricRunFailureReason'
        grainEndEpochSeconds:
          format: int64
          title: end of grain for METRIC_TIME based runs
          type: string
        grainStartEpochSeconds:
          format: int64
          title: start of grain for METRIC_TIME based runs
          type: string
        groupDimensions:
          items:
            $ref: '#/components/schemas/generatedMetricGroupDimension'
          type: array
        groupName:
          type: string
        hasRowCounts:
          type: boolean
        hasRowsMatched:
          type: boolean
        id:
          format: int32
          type: integer
        isPosthoc:
          type: boolean
        metricRunAnnotation:
          $ref: '#/components/schemas/generatedMetricRunAnnotation'
        observedValue:
          format: double
          type: number
        rowsMatched:
          format: int64
          type: string
        rowsScanned:
          format: int64
          type: string
        runAtEpochSeconds:
          format: int64
          type: string
        status:
          $ref: '#/components/schemas/generatedMetricRunStatus'
        summaryStatus:
          $ref: '#/components/schemas/generatedMetricStatus'
        thresholds:
          items:
            $ref: '#/components/schemas/generatedConstantThreshold'
          type: array
      type: object
    generatedPredefinedMetricName:
      default: UNDEFINED_PREDEFINED_METRIC_NAME
      enum:
      - UNDEFINED_PREDEFINED_METRIC_NAME
      - PERCENT_NULL
      - COUNT_NULL
      - PERCENT_EMPTY_STRING
      - COUNT_EMPTY_STRING
      - PERCENT_UNIQUE
      - PERCENT_VALUE_IN_LIST
      - AVERAGE
      - MIN
      - MAX
      - SUM
      - COUNT_ROWS
      - COUNT_DISTINCT
      - HOURS_SINCE_MAX_DATE
      - HOURS_SINCE_MAX_TIMESTAMP
      - COUNT_TRUE
      - PERCENT_TRUE
      - COUNT_FALSE
      - PERCENT_FALSE
      - COUNT_USA_PHONE
      - PERCENT_USA_PHONE
      - COUNT_USA_ZIP_CODE
      - PERCENT_USA_ZIP_CODE
      - PERCENT_UUID
      - COUNT_TIMESTAMP_STRING
      - PERCENT_TIMESTAMP_STRING
      - COUNT_DUPLICATES
      - COUNT_USA_STATE_CODE
      - PERCENT_USA_STATE_CODE
      - VARIANCE
      - SKEW
      - KURTOSIS
      - GEOMETRIC_MEAN
      - HARMONIC_MEAN
      - COUNT_UUID
      - COUNT_CUSIP
      - PERCENT_CUSIP
      - COUNT_SEDOL
      - PERCENT_SEDOL
      - COUNT_ISIN
      - PERCENT_ISIN
      - COUNT_LEI
      - PERCENT_LEI
      - COUNT_FIGI
      - PERCENT_FIGI
      - COUNT_PERM_ID
      - PERCENT_PERM_ID
      - COUNT_NAN
      - PERCENT_NAN
      - COUNT_LONGITUDE
      - PERCENT_LONGITUDE
      - COUNT_LATITUDE
      - PERCENT_LATITUDE
      - COUNT_NOT_IN_FUTURE
      - PERCENT_NOT_IN_FUTURE
      - COUNT_DATE_NOT_IN_FUTURE
      - PERCENT_DATE_NOT_IN_FUTURE
      - MEDIAN
      - PERCENTILE
      - COUNT_NOT_NULL
      - STRING_LENGTH_AVERAGE
      - STRING_LENGTH_MIN
      - STRING_LENGTH_MAX
      - COUNT_SSN
      - PERCENT_SSN
      - COUNT_EMAIL
      - PERCENT_EMAIL
      - ROWS_INSERTED
      - HOURS_SINCE_LAST_LOAD
      - COUNT_READ_QUERIES
      - PERCENT_NOT_NULL
      - FRESHNESS
      - VOLUME
      - FRESHNESS_DATA
      - VOLUME_DATA
      - COUNT_VALUE_IN_LIST
      - PERCENT_DISTINCT
      - PERCENT_DUPLICATES
      - HOURS_SINCE_MAX_STRING
      type: string
    generatedMonitoredObject:
      properties:
        entityInfo:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        entityType:
          $ref: '#/components/schemas/generatedCatalogEntityType'
      type: object
    generatedSimpleBound:
      properties:
        boundType:
          $ref: '#/components/schemas/generatedSimpleBoundType'
        value:
          description: Value of the threshold. For AutoThreshold types this is ignored.
          format: double
          type: number
      type: object
    generatedCompanionMetric:
      properties:
        id:
          format: int32
          type: integer
        metricInfo:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
        type:
          $ref: '#/components/schemas/generatedCompanionMetricType'
      type: object
    generatedTableApplicableMetricTypes:
      properties:
        applicableMetricTypes:
          items:
            $ref: '#/components/schemas/generatedColumnApplicableMetricTypes'
          type: array
        id:
          format: int32
          type: integer
      type: object
    generatedRowCreationTimeFilter:
      properties:
        lookback:
          $ref: '#/components/schemas/generatedTimeInterval'
        rctColumn:
          $ref: '#/components/schemas/generatedIdAndDisplayName'
      type: object
    generatedMetricGroupDimension:
      properties:
        columnName:
          type: string
        columnValue:
          type: string
        nullValue:
          type: boolean
      type: object
    generatedGetDeltaApplicableMetricTypesResponse:
      properties:
        metricTypes:
          $ref: '#/components/schemas/generatedTableApplicableMetricTypes'
      type: object
    generatedPredefinedMetric:
      properties:
        metricName:
          $ref: '#/components/schemas/generatedPredefinedMetricName'
      type: object
    generatedMetricRunLabel:
      default: METRIC_RUN_LABEL_UNSPECIFIED
      enum:
      - METRIC_RUN_LABEL_UNSPECIFIED
      - METRIC_RUN_LABEL_TRUE_NEGATIVE
      - METRIC_RUN_LABEL_FALSE_NEGATIVE
      - METRIC_RUN_LABEL_TRUE_POSITIVE
      - METRIC_RUN_LABEL_FALSE_POSITIVE
      - METRIC_RUN_LABEL_UNDETERMINED
      - METRIC_RUN_LABEL_EXPECTED
      type: string
    generatedCompanionMetricType:
      default: TYPE_FRESHNESS_VOLUME
      enum:
      - TYPE_FRESHNESS_VOLUME
      type: string
    generatedThreshold:
      properties:
        autoThreshold:
          $ref: '#/components/schemas/generatedAutoThreshold'
        constantThreshold:
          $ref: '#/components/schemas/generatedConstantThreshold'
        freshnessScheduleThreshold:
          $ref: '#/components/schemas/generatedFreshnessScheduleThreshold'
        noneThreshold:
          $ref: '#/components/schemas/generatedNoneThreshold'
        relativeThreshold:
          $ref: '#/components/schemas/generatedRelativeThreshold'
        standardDeviationThreshold:
          $ref: '#/components/schemas/generatedStandardDeviationThreshold'
      type: object
    generatedIssueExternalTicketInfo:
      properties:
        externalTicketId:
          type: string
        externalTicketProvider:
          $ref: '#/components/schemas/generatedExternalTicketProvider'
        externalTicketUrl:
          type: string
        issueId:
          format: int32
          type: integer
      type: object
    generatedNotificationChannel:
      properties:
        email:
          type: string
        externalTicketInfo:
          $ref: '#/components/schemas/generatedIssueExternalTicketInfo'
        slackChannelInfo:
          $ref: '#/components/schemas/generatedSlackChannelInfo'
        webhook:
          $ref: '#/components/schemas/generatedWebhook'
      type: object
    generatedCustomRulesThresholdType:
      default: CUSTOM_RULES_THRESHOLD_TYPE_UNSPECIFIED
      enum:
      - CUSTOM_RULES_THRESHOLD_TYPE_UNSPECIFIED
      - CUSTOM_RULES_THRESHOLD_TYPE_COUNT
      - CUSTOM_RULES_THRESHOLD_TYPE_VALUE
      - CUSTOM_RULES_THRESHOLD_TYPE_PERCENT_MATCH
      type: string
    generatedWarehouseType:
      default: DATABASE_TYPE_UNSPECIFIED
      enum:
      - DATABASE_TYPE_UNSPECIFIED
      - DATABASE_TYPE_AWS_ATHENA
      - DATABASE_TYPE_BIGQUERY
      - DATABASE_TYPE_DATABRICKS
      - DATABASE_TYPE_MYSQL
      - DATABASE_TYPE_ORACLE
      - DATABASE_TYPE_POSTGRES
      - DATABASE_TYPE_PRESTO
      - DATABASE_TYPE_REDSHIFT
      - DATABASE_TYPE_SAP_HANA
      - DATABASE_TYPE_SNOWFLAKE
      - DATABASE_TYPE_SQL_SERVER
      - DATABASE_TYPE_SYNAPSE
      - DATABASE_TYPE_ROCKSET
      - DATABASE_TYPE_VERTICA
      - DATABASE_TYPE_AVATICA
      - DATABASE_TYPE_DB2
      - DATABASE_TYPE_TERADATA
      - DATABASE_TYPE_NETEZZA
      - D

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-comparisontableservice-api-openapi.yml