List benchmarks

List benchmarks with optional filtering

GET /v1/retrievers/benchmarks

List benchmarks

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/benchmarks

200

{
  "benchmarks": [
    {
      "benchmark_id": "<string>",
      "benchmark_name": "<string>",
      "baseline_retriever_id": "<string>",
      "candidate_retriever_ids": [
        "<string>"
      ],
      "session_count": 123,
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "session_filter": {
        "retriever_ids": [
          "<string>"
        ],
        "taxonomy_node_ids": [
          "<string>"
        ],
        "time_range": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "min_interactions": 1,
        "interaction_types": [
          "<string>"
        ],
        "sample_strategy": "random",
        "interaction_weights": {
          "weights": {}
        }
      },
      "results": [
        {
          "retriever_id": "<string>",
          "retriever_name": "<string>",
          "pipeline_hash": "<string>",
          "metrics": {
            "ndcg_at_k": {},
            "mean_rank_clicked": 123,
            "recall_at_k": {},
            "avg_position_delta": 123,
            "items_promoted": 1,
            "items_demoted": 1,
            "sessions_improved": 1,
            "sessions_degraded": 1,
            "sessions_neutral": 1,
            "mean_rank_purchased": 123
          },
          "latency": {
            "p50_ms": 1,
            "p90_ms": 1,
            "p99_ms": 1,
            "mean_ms": 1,
            "stage_latencies": {}
          },
          "failed_sessions": 1,
          "taxonomy_deltas": {},
          "error_summary": {}
        }
      ],
      "comparison": {
        "baseline_retriever_id": "<string>",
        "comparisons": [
          {
            "candidate_retriever_id": "<string>",
            "ndcg_delta": {},
            "recall_delta": {},
            "latency_delta_ms": 123,
            "p_value": 123,
            "confidence_interval": {
              "[0]": 123,
              "[1]": 123
            },
            "taxonomy_wins": [
              "<string>"
            ],
            "taxonomy_losses": [
              "<string>"
            ]
          }
        ],
        "recommendation": "<string>"
      },
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>"
    }
  ],
  "total": 123,
  "page": 1,
  "page_size": 20
}

Headers

Authorization · string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

authorization · string

X-Namespace · string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Query Parameters

retriever_id · string | null

Filter to benchmarks involving this retriever (as baseline or candidate)

status · string | null

Filter by status (pending, building_sessions, replaying, completed, failed)

page · integer · default: 1

Page number

Required range: x >= 1

page_size · integer · default: 20

Items per page

Required range: 1 <= x <= 1000

Response

200

application/json

Successful Response

Response for listing benchmarks.

benchmarks · BenchmarkResponse · object[] · required

List of benchmarks.

Show child attributes

total · integer · required

Total count matching filter.

page · integer · default: 1

Current page.

page_size · integer · default: 20

Items per page.