Skip to main content
GET
/
v1
/
retrievers
/
{retriever_id}
/
evaluations
List evaluations
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations
{
  "evaluations": [
    {
      "evaluation_id": "<string>",
      "retriever_id": "<string>",
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "config": {
        "k_values": [
          1,
          5,
          10,
          20
        ],
        "metrics": [
          "precision",
          "recall",
          "f1",
          "map",
          "ndcg",
          "mrr"
        ]
      },
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "namespace_id": "<string>",
      "internal_id": "<string>",
      "query_count": 123,
      "completed_at": "2023-11-07T05:31:56Z",
      "overall_metrics": {},
      "metrics_by_k": {},
      "error_message": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}

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"

​
X-Namespace
string

REQUIRED: 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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
retriever_id
string
required

Query Parameters

​
status
enum<string> | null

Filter by status (pending, in_progress, completed, failed) Status of an evaluation run.

Available options:
pending,
in_progress,
completed,
failed
​
dataset_name
string | null

Filter by dataset name

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
page_size
integer
default:20

Items per page

Required range: 1 <= x <= 1000

Response

Successful Response

Response for listing evaluations.

​
evaluations
EvaluationRecord · object[]
required

List of evaluations

​
total
integer
required

Total count

​
page
integer
required

Current page

​
page_size
integer
required

Page size