> ## 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.

# List all metrics



## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/openapi.yaml get /v1/metrics
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:
    get:
      tags:
        - Metrics
      summary: List all metrics
      operationId: getMetrics
      parameters:
        - name: type
          in: query
          required: false
          schema:
            type: string
          description: Filter by metric type
        - name: id
          in: query
          required: false
          schema:
            type: string
          description: Filter by specific metric ID
      responses:
        '200':
          description: Metrics retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetricsResponse'
components:
  schemas:
    GetMetricsResponse:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricItem'
      required:
        - metrics
      description: Response for GET /metrics
    MetricItem:
      type: object
      properties:
        name:
          type: string
          maxLength: 200
        type:
          type: string
          enum:
            - PYTHON
            - LLM
            - HUMAN
            - COMPOSITE
        criteria:
          type: string
          minLength: 1
        description:
          type:
            - string
            - 'null'
        return_type:
          type: string
          enum:
            - float
            - boolean
            - string
            - categorical
        enabled_in_prod:
          type: boolean
        needs_ground_truth:
          type: boolean
        sampling_percentage:
          type: number
          minimum: 0
          maximum: 100
        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/MetricItemCategoriesItem'
          minItems: 1
        child_metrics:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/MetricItemChildMetricsItem'
          minItems: 1
        filters:
          $ref: '#/components/schemas/MetricItemFilters'
        id:
          type: string
          minLength: 1
        created_at:
          type: string
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - name
        - type
        - criteria
        - description
        - return_type
        - enabled_in_prod
        - needs_ground_truth
        - sampling_percentage
        - filters
        - id
        - created_at
        - updated_at
      additionalProperties: false
    MetricItemCategoriesItem:
      type: object
      properties:
        category:
          type: string
          maxLength: 200
        score:
          type:
            - number
            - 'null'
      required:
        - category
        - score
      additionalProperties: false
    MetricItemChildMetricsItem:
      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
    MetricItemFilters:
      type: object
      properties:
        filterArray:
          $ref: '#/components/schemas/FiltersArray'
      required:
        - filterArray
      additionalProperties: false
    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

````