Get Retriever Performance

Get retriever performance metrics for tuning.

Retrieves time-series performance data including:

• Query latency (P50, P95, P99)
• Query counts
• Result counts
• Latency trends

Use Cases:

• Monitor retriever performance over time
• Identify performance degradations
• Compare performance across time periods
• Establish performance baselines

Example:

curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/performance?hours=24&group_by=hour" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"

GET /v1/analytics/retrievers/{retriever_id}/performance

Get Retriever Performance

cURL

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

200

{
  "retriever_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {}
  ],
  "summary": {}
}

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.

Path Parameters

retriever_id · string · required

Query Parameters

start_date · string<date-time> | null

Start date (UTC)

end_date · string<date-time> | null

End date (UTC)

group_by · string · default: hour

Time grouping: hour, day, week

Response

200

application/json

Successful Response

Retriever performance metrics response.

retriever_id · string · required

Retriever identifier

Example:

"ret_abc123"

time_range · TimeRange · object · required

Time range of the data

Show child attributes

metrics · Metrics · object[] · required

Time-series performance metrics

summary · Summary · object | null

Aggregated summary statistics