Retrieve experiment result

Compute evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.

GET /v1/runs/{run_id}/result

Retrieve experiment result

cURL

curl --request GET \
  --url https://api.dp1.us.honeyhive.ai/v1/runs/{run_id}/result \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "<string>",
  "success": true,
  "passed": [
    "<string>"
  ],
  "failed": [
    "<string>"
  ],
  "metrics": {
    "aggregation_function": "<string>",
    "details": [
      {
        "metric_name": "<string>",
        "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>",
    "metadata": {},
    "results": {},
    "event_ids": [
      "<string>"
    ],
    "configuration": {},
    "is_active": true,
    "created_at": "<string>",
    "scope_type": "<string>",
    "scope_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "metrics": {},
    "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 · string object[]

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

Response

200

application/json

Experiment result retrieved successfully

Evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.

status · string · required

success · boolean · required

passed · string[] · required

failed · string[] · required

metrics · object · required

Show child attributes

datapoints · object[] · required

Show child attributes

event_details · object[] · required

Show child attributes

run_object · object · required

Show child attributes

error · string