Skip to main content
GET
Compare events between two experiment runs

Authorizations

Authorization
string
header
required

A fine-grained data plane API key (values begin with hh_fgdp_). Rooted at an organization, workspace, or project, it carries the permissions chosen when it was created, and only the operations whose paths begin with /v1/projects/{project_id}/ accept it. Create one in the HoneyHive app under the project's, workspace's, or organization's Settings → API Keys, on the Data Plane tab.

Path Parameters

project_id
string
required

The unique identifier of the project that holds both runs

new_run_id
string<uuid>
required

New experiment run ID (UUIDv4)

old_run_id
string<uuid>
required

Old experiment run ID to compare against (UUIDv4)

Query Parameters

event_name
string

Filter by event name

event_type
string

Filter by event type

filter

Additional filter criteria (JSON string or object)

limit
integer
default:1000

Maximum number of results

Required range: 1 <= x <= 1000
page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

Event comparison retrieved successfully

Response for GET /runs/{new_run_id}/compare/{old_run_id}/events

events
object[]
required
totalEvents
integer
required

Total number of events matching the comparison query