Bigeye Metric Service API

The MetricService API from Bigeye — 20 operation(s) for metricservice.

OpenAPI Specification

bigeye-metricservice-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Observability Metric Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: MetricService
paths:
  /api/v1/metrics/batch:
    put:
      operationId: MetricService_BatchEditMetrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedBatchMetricConfigRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBatchMetricConfigResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Batch edit metrics
      tags:
      - MetricService
  /api/v1/metrics/bulk:
    put:
      operationId: MetricService_BulkUpdateMetrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedBulkMetricOperation'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBulkResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Performs bulk metric updates
      tags:
      - MetricService
  /api/v1/metrics/comparisons/bulk:
    put:
      operationId: MetricService_BulkUpdatesDeltas
      requestBody:
        $ref: '#/components/requestBodies/generatedBulkDeltaOperation'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBulkResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Performs bulk Delta updates
      tags:
      - MetricService
  /api/v1/metrics/{metricId}/debug/preview:
    get:
      operationId: MetricService_GetDebugPreview
      parameters:
      - in: path
        name: metricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetPreviewResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get sample debug rows for debug page
      tags:
      - MetricService
  /api/v1/metrics/{metricId}/debug/queries:
    get:
      operationId: MetricService_GetDebugQueries
      parameters:
      - in: path
        name: metricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetDebugQueriesResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get queries for debug page
      tags:
      - MetricService
  /api/v1/metrics/metadata-metric-names:
    get:
      operationId: MetricService_GetMetadataMetricNames
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricNamesResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Gets the list of all metadata metric names
      tags:
      - MetricService
  /api/v1/metrics/{metricId}:
    delete:
      operationId: MetricService_DeleteMetric
      parameters:
      - description: The ID of the metric
        in: path
        name: metricId
        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 metric
      tags:
      - MetricService
    get:
      operationId: MetricService_GetMetricConfiguration
      parameters:
      - description: The ID of the metric
        in: path
        name: metricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricConfiguration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get metric configuration
      tags:
      - MetricService
  /api/v1/metrics/info/{metricId}:
    get:
      operationId: MetricService_GetMetricInfo
      parameters:
      - description: The ID of the metric
        in: path
        name: metricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get single metric information
      tags:
      - MetricService
  /api/v1/metrics/info:
    get:
      operationId: MetricService_GetMetricInfoBatch
      parameters:
      - in: query
        name: metricIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - description: If searching by table name or schema name, at least one warehouse ID must be present.
        in: query
        name: warehouseIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableName
        required: false
        schema:
          type: string
      - description: 'Valid statuses are: healthy, alerting, unknown.'
        in: query
        name: status
        required: false
        schema:
          type: string
      - in: query
        name: metricCreationStates
        required: false
        explode: true
        schema:
          type: array
          items:
            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
      - in: query
        name: muted
        required: false
        schema:
          type: string
          enum:
          - THREE_LEGGED_BOOLEAN_UNSPECIFIED
          - THREE_LEGGED_BOOLEAN_TRUE
          - THREE_LEGGED_BOOLEAN_FALSE
          default: THREE_LEGGED_BOOLEAN_UNSPECIFIED
      - in: query
        name: pageSize
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: pageCursor
        required: false
        schema:
          type: string
      - in: query
        name: sortField
        required: false
        schema:
          type: string
          enum:
          - METRIC_SORT_FIELD_UNSPECIFIED
          - METRIC_SORT_FIELD_METRIC_NAME
          - METRIC_SORT_FIELD_RAN_AT
          - METRIC_SORT_FIELD_ALERTING
          - METRIC_SORT_FIELD_SCHEMA
          - METRIC_SORT_FIELD_TABLE
          - METRIC_SORT_FIELD_COLUMN
          - METRIC_SORT_FIELD_FAVORITE
          - METRIC_SORT_FIELD_CREATED_AT
          - METRIC_SORT_FIELD_BIGCONFIG
          default: METRIC_SORT_FIELD_UNSPECIFIED
      - in: query
        name: schemaName
        required: false
        schema:
          type: string
      - in: query
        name: columnIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: search
        required: false
        schema:
          type: string
      - in: query
        name: sortDirection
        required: false
        schema:
          type: string
          enum:
          - SORT_DIRECTION_UNSPECIFIED
          - SORT_DIRECTION_ASCENDING
          - SORT_DIRECTION_DESCENDING
          default: SORT_DIRECTION_UNSPECIFIED
      - in: query
        name: schemaId
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: metricTypes
        required: false
        explode: true
        schema:
          type: array
          items:
            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
      - in: query
        name: includeLatestMetricRuns
        required: false
        schema:
          type: boolean
      - in: query
        name: workspaceId
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: tagIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: dimensionIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: templateIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: monitorTypes
        required: false
        explode: true
        schema:
          type: array
          items:
            enum:
            - MONITOR_TYPE_UNDEFINED
            - MONITOR_TYPE_METRIC
            - MONITOR_TYPE_DBT_TEST
            - MONITOR_TYPE_CUSTOM_RULE
            type: string
      - in: query
        name: conversationIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int64
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricInfoList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get metric information
      tags:
      - MetricService
    post:
      operationId: MetricService_GetMetricInfoBatchPost
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedGetMetricInfoListRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricInfoList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get batch metric information
      tags:
      - MetricService
  /api/v1/metrics/runs:
    post:
      operationId: MetricService_GetMetricRuns
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedGetMetricRunsRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetMetricRunsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get metric runs
      tags:
      - MetricService
  /api/v1/metrics/count:
    get:
      operationId: MetricService_GetMetricsCount
      parameters:
      - in: query
        name: metricIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - description: If searching by table name or schema name, at least one warehouse ID must be present.
        in: query
        name: warehouseIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableName
        required: false
        schema:
          type: string
      - description: 'Valid statuses are: healthy, alerting, unknown.'
        in: query
        name: status
        required: false
        schema:
          type: string
      - in: query
        name: metricCreationStates
        required: false
        explode: true
        schema:
          type: array
          items:
            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
      - in: query
        name: muted
        required: false
        schema:
          type: string
          enum:
          - THREE_LEGGED_BOOLEAN_UNSPECIFIED
          - THREE_LEGGED_BOOLEAN_TRUE
          - THREE_LEGGED_BOOLEAN_FALSE
          default: THREE_LEGGED_BOOLEAN_UNSPECIFIED
      - in: query
        name: pageSize
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: pageCursor
        required: false
        schema:
          type: string
      - in: query
        name: sortField
        required: false
        schema:
          type: string
          enum:
          - METRIC_SORT_FIELD_UNSPECIFIED
          - METRIC_SORT_FIELD_METRIC_NAME
          - METRIC_SORT_FIELD_RAN_AT
          - METRIC_SORT_FIELD_ALERTING
          - METRIC_SORT_FIELD_SCHEMA
          - METRIC_SORT_FIELD_TABLE
          - METRIC_SORT_FIELD_COLUMN
          - METRIC_SORT_FIELD_FAVORITE
          - METRIC_SORT_FIELD_CREATED_AT
          - METRIC_SORT_FIELD_BIGCONFIG
          default: METRIC_SORT_FIELD_UNSPECIFIED
      - in: query
        name: schemaName
        required: false
        schema:
          type: string
      - in: query
        name: columnIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: search
        required: false
        schema:
          type: string
      - in: query
        name: sortDirection
        required: false
        schema:
          type: string
          enum:
          - SORT_DIRECTION_UNSPECIFIED
          - SORT_DIRECTION_ASCENDING
          - SORT_DIRECTION_DESCENDING
          default: SORT_DIRECTION_UNSPECIFIED
      - in: query
        name: schemaId
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: metricTypes
        required: false
        explode: true
        schema:
          type: array
          items:
            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
      - in: query
        name: includeLatestMetricRuns
        required: false
        schema:
          type: boolean
      - in: query
        name: workspaceId
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: tagIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: dimensionIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: templateIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: monitorTypes
        required: false
        explode: true
        schema:
          type: array
          items:
            enum:
            - MONITOR_TYPE_UNDEFINED
            - MONITOR_TYPE_METRIC
            - MONITOR_TYPE_DBT_TEST
            - MONITOR_TYPE_CUSTOM_RULE
            type: string
      - in: query
        name: conversationIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int64
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetMetricsCountResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get count of metrics
      tags:
      - MetricService
  /api/v1/metrics/{metricId}/revisions:
    get:
      operationId: MetricService_GetRevisions
      parameters:
      - description: The ID of the metric
        in: path
        name: metricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetMetricRevisionsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get metric revisions / history / timeline
      tags:
      - MetricService
  /api/v1/metrics/scorecard:
    post:
      operationId: MetricService_GetScorecard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedGetMetricScorecardRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetMetricScorecardResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get metric scorecard
      tags:
      - MetricService
  /api/v1/metrics/table-level-metric-names:
    get:
      operationId: MetricService_GetTableLevelMetricNames
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricNamesResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Gets the list of all table-level metric names
      tags:
      - MetricService
  /api/v1/metrics/run/{metricId}:
    get:
      operationId: MetricService_RunMetric
      parameters:
      - description: The ID of the metric
        in: path
        name: metricId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Run metric
      tags:
      - MetricService
  /api/v1/metrics/run/batch:
    post:
      operationId: MetricService_RunMetricBatch
      requestBody:
        $ref: '#/components/requestBodies/generatedBatchRunMetricsRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBatchRunMetricsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Batch run metrics
      tags:
      - MetricService
  /api/v1/metrics/run/batch/queue:
    post:
      operationId: MetricService_RunMetricBatchQueue
      requestBody:
        $ref: '#/components/requestBodies/generatedBatchRunMetricsRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedWorkflowResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: 'Queue batch run metrics. This is useful for batches that take a long time to run.

        Returns a WorkflowResponse, which contains a workflow_id.

        The status of the batch can be checked by using the /api/v1/workflows/{workflow_id}/status endpoint.'
      tags:
      - MetricService
  /api/v1/metrics/backfill:
    get:
      operationId: MetricService_SearchMetricBackfill
      parameters:
      - in: query
        name: ids
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - description: If searching by table name, at least one warehouse ID must be present.
        in: query
        name: warehouseIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableName
        required: false
        schema:
          type: string
      - description: 'Valid statuses are: METRIC_BACKFILL_RUN_STATUS_QUEUED, METRIC_BACKFILL_RUN_STATUS_FAILED, METRIC_BACKFILL_RUN_STATUS_SUCCEEDED.'
        in: query
        name: status
        required: false
        explode: true
        schema:
          type: array
          items:
            enum:
            - METRIC_BACKFILL_RUN_STATUS_UNSPECIFIED
            - METRIC_BACKFILL_RUN_STATUS_QUEUED
            - METRIC_BACKFILL_RUN_STATUS_FAILED
            - METRIC_BACKFILL_RUN_STATUS_SUCCEEDED
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricBackfillResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get backfill status
      tags:
      - MetricService
    post:
      operationId: MetricService_BackfillMetric
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedMetricBackfillRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedMetricBackfillResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Backfill metric
      tags:
      - MetricService
  /api/v1/metrics:
    get:
      operationId: MetricService_SearchMetricConfiguration
      parameters:
      - in: query
        name: ids
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - description: If searching by table name, at least one warehouse ID must be present.
        in: query
        name: warehouseIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableIds
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: tableName
        required: false
        schema:
          type: string
      - description: 'Valid statuses are: healthy, alerting, unknown.'
        in: query
        name: status
        required: false
        schema:
          type: string
      - in: query
        name: muted
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: A successful response.
          content:
 

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