Skip to main content
GET
/
v1
/
runs
/
{run_id}
/
result
Retrieve experiment result
curl --request GET \
  --url https://api.honeyhive.ai/v1/runs/{run_id}/result \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "success": true,
  "passed": [
    "<string>"
  ],
  "failed": [
    "<string>"
  ],
  "metrics": {
    "aggregation_function": "<string>",
    "details": [
      {
        "metric_name": "<string>",
        "metric_type": "COMPOSITE",
        "event_name": "<string>",
        "event_type": "<string>",
        "aggregate": 123,
        "values": [
          123
        ],
        "passing_range": {
          "min": 123,
          "max": 123
        },
        "datapoints": {
          "passed": [
            "<string>"
          ],
          "failed": [
            "<string>"
          ]
        }
      }
    ]
  },
  "datapoints": [
    {
      "session_id": "<string>",
      "passed": true,
      "datapoint_id": "<string>",
      "metrics": [
        "<unknown>"
      ]
    }
  ],
  "event_details": [
    {
      "event_name": "<string>",
      "event_type": "<string>"
    }
  ],
  "run_object": {
    "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>"
  },
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

run_id
string<uuid>
required

Experiment run ID (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 result retrieved successfully

Evaluation summary for an experiment run including pass/fail status, metrics, and datapoints

status
string
required
success
boolean
required
passed
string[]
required
failed
string[]
required
metrics
object
required
datapoints
object[]
required
event_details
object[]
required
run_object
object
required
error
string