Skip to main content
GET
/
v1
/
runs
/
{new_run_id}
/
compare-with
/
{old_run_id}
Retrieve experiment comparison
curl --request GET \
  --url https://api.honeyhive.ai/v1/runs/{new_run_id}/compare-with/{old_run_id} \
  --header 'Authorization: Bearer <token>'
{
  "metrics": [
    {
      "metric_name": "<string>",
      "metric_type": "<string>",
      "old_aggregate": 123,
      "new_aggregate": 123,
      "difference": 123,
      "percentage_change": 123
    }
  ],
  "commonDatapoints": [
    "<string>"
  ],
  "event_details": [
    {
      "event_name": "<string>",
      "event_type": "<string>",
      "presence": "old"
    }
  ],
  "old_run": {
    "id": "<string>",
    "run_id": "<string>",
    "created_at": "<string>",
    "scope_type": "<string>",
    "scope_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "metadata": {},
    "results": {},
    "event_ids": [],
    "configuration": {},
    "is_active": true,
    "updated_at": "<string>",
    "dataset_id": "<string>"
  },
  "new_run": {
    "id": "<string>",
    "run_id": "<string>",
    "created_at": "<string>",
    "scope_type": "<string>",
    "scope_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "metadata": {},
    "results": {},
    "event_ids": [],
    "configuration": {},
    "is_active": true,
    "updated_at": "<string>",
    "dataset_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

new_run_id
string<uuid>
required

New experiment run ID to compare (UUIDv4)

old_run_id
string<uuid>
required

Old experiment run ID to compare against (UUIDv4)

Query Parameters

aggregate_function
enum<string>
default:average

Aggregation function to apply to metrics

Available options:
average,
min,
max,
median,
p95,
p99,
p90,
sum,
count
filters

Optional filters to apply (JSON string or array of filter objects)

Response

Experiment comparison retrieved successfully

Comparison between two experiment runs including metrics, common datapoints, and event details

metrics
object[]
required
commonDatapoints
string[]
required
event_details
object[]
required
old_run
object
required
new_run
object
required