List benchmarks

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/benchmarks \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/retrievers/benchmarks"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/retrievers/benchmarks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/benchmarks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/retrievers/benchmarks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/benchmarks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "benchmarks": [
    {
      "benchmark_id": "<string>",
      "benchmark_name": "<string>",
      "baseline_retriever_id": "<string>",
      "candidate_retriever_ids": [
        "<string>"
      ],
      "session_count": 123,
      "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
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

GET

retrievers

benchmarks

List benchmarks

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/benchmarks \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/retrievers/benchmarks"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/retrievers/benchmarks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/benchmarks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/retrievers/benchmarks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/benchmarks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "benchmarks": [
    {
      "benchmark_id": "<string>",
      "benchmark_name": "<string>",
      "baseline_retriever_id": "<string>",
      "candidate_retriever_ids": [
        "<string>"
      ],
      "session_count": 123,
      "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
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

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

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.

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

List benchmarks

Authorizations

Query Parameters

Response