Get Retriever Signals

Get retriever signals for interaction tuning.

Retrieves fine-grained signals about retriever behavior:

• Cache hits/misses
• Reranking scores
• Filter effectiveness
• Query expansion results

Signal Types:

• cache_hit: Successful cache lookups
• cache_miss: Cache misses requiring full search
• rerank_scores: Reranking effectiveness metrics
• filter_reduction: Pre-filter document reduction
• expansion_results: Query expansion impact

Use Cases:

• Fine-tune retrieval parameters
• Analyze query patterns
• Optimize cache strategies
• Validate optimization improvements

Example:

curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/signals?signal_type=rerank_scores&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"

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

Get Retriever Signals

cURL

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

200

[
  {
    "timestamp": "2023-11-07T05:31:56Z",
    "execution_id": "<string>",
    "signal_type": "<string>",
    "signal_data": {},
    "metadata": {}
  }
]

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

signal_type · string | null

Filter by signal type (cache_hit, rerank_scores, etc.)

limit · integer · default: 100

Maximum results

Required range: x <= 1000

hours · integer · default: 24

Hours of history

Required range: 1 <= x <= 720

Response

200

application/json

Successful Response

timestamp · string<date-time> · required

Event timestamp

execution_id · string · required

Execution identifier

signal_type · string · required

Type of signal

Examples:

"cache_hit"

"rerank_scores"

"filter_reduction"

signal_data · Signal Data · object · required

Signal-specific data

metadata · Metadata · object | null

Additional metadata