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

# Retrieve experiment comparison (deprecated)

> Deprecated. Use `GET /v1/runs/{new_run_id}/compare/{old_run_id}` instead.



## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/openapi.yaml get /v1/runs/{new_run_id}/compare-with/{old_run_id}
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/runs/{new_run_id}/compare-with/{old_run_id}:
    get:
      tags:
        - Experiments
      summary: Retrieve experiment comparison (deprecated)
      description: >-
        Deprecated. Use `GET /v1/runs/{new_run_id}/compare/{old_run_id}`
        instead.
      operationId: getExperimentComparisonLegacy
      parameters:
        - name: new_run_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: New experiment run ID to compare (UUIDv4)
        - name: old_run_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Old experiment run ID to compare against (UUIDv4)
        - name: aggregate_function
          in: query
          required: false
          schema:
            type: string
          description: Aggregation function to apply to metrics
        - name: filters
          in: query
          required: false
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: object
          description: Optional filters to apply (JSON string or array of filter objects)
      responses:
        '200':
          description: Experiment comparison retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExperimentRunCompareResponse'
        '400':
          description: Error processing experiment comparison
      deprecated: true
components:
  schemas:
    GetExperimentRunCompareResponse:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricComparison'
        commonDatapoints:
          type: array
          items:
            type: string
        event_details:
          type: array
          items:
            $ref: '#/components/schemas/EventComparisonDetail'
        old_run:
          $ref: '#/components/schemas/ExperimentRunObject'
        new_run:
          $ref: '#/components/schemas/ExperimentRunObject'
      required:
        - metrics
        - commonDatapoints
        - event_details
        - old_run
        - new_run
      description: >-
        Comparison between two experiment runs including metrics, common
        datapoints, and event details
    MetricComparison:
      type: object
      properties:
        metric_name:
          type: string
        metric_type:
          type: string
        old_aggregate:
          type: number
        new_aggregate:
          type: number
        difference:
          type: number
        percentage_change:
          type: number
      required:
        - metric_name
    EventComparisonDetail:
      type: object
      properties:
        event_name:
          type: string
        event_type:
          type: string
        presence:
          type: string
          enum:
            - old
            - new
            - both
      required:
        - event_name
        - event_type
        - presence
    ExperimentRunObject:
      type: object
      properties:
        id:
          type: string
        run_id:
          type: string
        name:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        status:
          type:
            - string
            - 'null'
        metadata:
          type: object
          additionalProperties: {}
        results:
          type: object
          additionalProperties: {}
        metrics:
          type: object
          additionalProperties:
            type: number
        event_ids:
          type: array
          items:
            type: string
        configuration:
          type: object
          additionalProperties: {}
        is_active:
          type: boolean
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
        updated_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - type: 'null'
        scope_type:
          type: string
        scope_id:
          type: string
        dataset_id:
          type:
            - string
            - 'null'
      required:
        - id
        - run_id
        - metadata
        - results
        - event_ids
        - configuration
        - is_active
        - created_at
        - scope_type
        - scope_id
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````