> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Run a metric evaluation (deprecated)

> Deprecated. Use `POST /v1/metrics/run` instead.



## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/openapi.yaml post /v1/metrics/run_metric
openapi: 3.1.0
info:
  title: HoneyHive Data Plane API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.2.1
servers:
  - url: https://api.honeyhive.ai
security:
  - BearerAuth: []
tags:
  - name: Charts
    description: >
      Define and manage saved charts. Charts are visualizations that aggregate
      metrics over time with bucketing, filters, and groupings.
  - name: Configurations
    description: >
      Manage prompt configurations, i.e. model parameters, message templates,
      and response settings that can be versioned and deployed without code
      changes.
  - name: Datapoints
    description: >
      Manage individual records inside datasets, including batch creation and
      mapping to source events.
  - name: Datasets
    description: >
      Curate collections of datapoints used as test sets for evaluations and
      experiments.
  - name: Events
    description: >
      Read and write trace events. Events are the spans that capture every step
      of an AI application's execution.
  - name: Experiments
    description: >
      Run, retrieve, and compare evaluation runs to measure how prompt or
      configuration changes affect agent performance.
  - name: Metric Versions
    description: >
      Snapshot, list, and deploy versions of a metric's definition so changes
      can be reviewed and rolled back without losing history.
  - name: Metrics
    description: >
      Define and run evaluators, i.e. automated quality checks that score traces
      against criteria like accuracy, safety, or correctness.
  - name: Queues
    description: >
      Manage annotation queues for human review of traces, turning expert
      feedback into labeled datasets.
  - name: Sessions
    description: >
      Group related trace events into sessions, the top-level container for a
      multi-step or multi-service AI interaction.
paths:
  /v1/metrics/run_metric:
    post:
      tags:
        - Metrics
      summary: Run a metric evaluation (deprecated)
      description: Deprecated. Use `POST /v1/metrics/run` instead.
      operationId: runMetricLegacy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegacyRunMetricRequest'
      responses:
        '200':
          description: Metric execution result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunMetricResponse'
      deprecated: true
components:
  schemas:
    LegacyRunMetricRequest:
      type: object
      properties:
        metric:
          $ref: '#/components/schemas/LegacyRunMetricRequestMetric'
        event:
          $ref: '#/components/schemas/LegacyRunMetricRequestEvent'
      required:
        - metric
        - event
      description: >-
        Request body for POST /metrics/run_metric (deprecated — use POST
        /metrics/run)
      deprecated: true
    RunMetricResponse:
      type: object
      properties:
        success:
          type: boolean
        loading:
          type: boolean
        result:
          anyOf:
            - type: boolean
            - type: number
            - type: string
            - type: 'null'
        explanation:
          type:
            - string
            - 'null'
      required:
        - success
        - loading
        - result
        - explanation
      description: Response for POST /metrics/run
    LegacyRunMetricRequestMetric:
      type: object
      properties:
        name:
          type: string
          maxLength: 200
        type:
          type: string
          enum:
            - LLM
            - PYTHON
        criteria:
          type: string
          minLength: 1
        description:
          type: string
          default: ''
        return_type:
          type: string
          enum:
            - float
            - boolean
            - string
            - categorical
          default: float
        enabled_in_prod:
          type: boolean
          default: false
        needs_ground_truth:
          type: boolean
          default: false
        sampling_percentage:
          type: number
          minimum: 0
          maximum: 100
          default: 10
        model_provider:
          type:
            - string
            - 'null'
        model_name:
          type:
            - string
            - 'null'
        scale:
          type:
            - integer
            - 'null'
          exclusiveMinimum: 0
        threshold:
          type:
            - object
            - 'null'
          properties:
            min:
              type: number
            max:
              type: number
            pass_when:
              anyOf:
                - type: boolean
                - type: number
            passing_categories:
              type: array
              items:
                type: string
                maxLength: 200
              minItems: 1
          additionalProperties: false
        categories:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/LegacyRunMetricRequestMetricCategoriesItem'
          minItems: 1
        child_metrics:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/LegacyRunMetricRequestMetricChildMetricsItem'
          minItems: 1
        filters:
          $ref: '#/components/schemas/LegacyRunMetricRequestMetricFilters'
      required:
        - name
        - type
        - criteria
      additionalProperties: false
    LegacyRunMetricRequestEvent:
      type: object
      properties:
        event_type:
          type: string
        event_name:
          type: string
        inputs:
          type: object
          additionalProperties: {}
        outputs:
          type: object
          additionalProperties: {}
        workspace_id:
          type: string
        feedback:
          $ref: '#/components/schemas/LegacyRunMetricRequestEventFeedback'
      additionalProperties: {}
    LegacyRunMetricRequestMetricCategoriesItem:
      type: object
      properties:
        category:
          type: string
          maxLength: 200
        score:
          type:
            - number
            - 'null'
      required:
        - category
        - score
      additionalProperties: false
    LegacyRunMetricRequestMetricChildMetricsItem:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        name:
          type: string
          maxLength: 200
        weight:
          type: number
        scale:
          type:
            - integer
            - 'null'
          exclusiveMinimum: 0
      required:
        - name
        - weight
      additionalProperties: false
    LegacyRunMetricRequestMetricFilters:
      type: object
      properties:
        filterArray:
          $ref: '#/components/schemas/FiltersArray'
      default:
        filterArray: []
      required:
        - filterArray
      additionalProperties: false
    LegacyRunMetricRequestEventFeedback:
      type: object
      properties:
        ground_truth: {}
      additionalProperties: {}
    FiltersArray:
      type: array
      items:
        $ref: '#/components/schemas/SingleFilter'
    SingleFilter:
      type: object
      properties:
        field:
          type: string
        operator:
          type: string
          enum:
            - exists
            - not exists
            - is
            - is not
            - contains
            - not contains
            - greater than
            - less than
            - after
            - before
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
        type:
          type: string
          enum:
            - string
            - number
            - boolean
            - datetime
      required:
        - field
        - operator
        - value
        - type
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````