Analytics
Analytics - Retrievers

Get Retriever Signals

Changed on

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

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/analytics/retrievers/{retriever_id}/signals
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

retriever_idstring required

Query parameters

signal_typestring nullable

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

limitinteger

Maximum results

hoursinteger

Hours of history

Response

Successful Response

timestampstring date-time required

Event timestamp

execution_idstring required

Execution identifier

signal_typestring required

Type of signal

signal_dataobject required

Signal-specific data

metadataobject nullable

Additional metadata

Example response

[
  {
    "signal_type": "cache_hit"
  }
]

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API