> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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:**
```bash
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"
```



## OpenAPI

````yaml get /v1/analytics/retrievers/{retriever_id}/signals
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/analytics/retrievers/{retriever_id}/signals:
    get:
      tags:
        - Analytics
        - Analytics - Retrievers
      summary: Get Retriever Signals
      description: >-
        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:**

        ```bash

        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"
        ```
      operationId: get_retriever_signals_v1_analytics_retrievers__retriever_id__signals_get
      parameters:
        - name: retriever_id
          in: path
          required: true
          schema:
            type: string
            title: Retriever Id
        - name: signal_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by signal type (cache_hit, rerank_scores, etc.)
            title: Signal Type
          description: Filter by signal type (cache_hit, rerank_scores, etc.)
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            description: Maximum results
            default: 100
            title: Limit
          description: Maximum results
        - name: hours
          in: query
          required: false
          schema:
            type: integer
            maximum: 720
            minimum: 1
            description: Hours of history
            default: 24
            title: Hours
          description: Hours of history
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RetrieverSignal'
                title: >-
                  Response Get Retriever Signals V1 Analytics Retrievers 
                  Retriever Id  Signals Get
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    RetrieverSignal:
      properties:
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Event timestamp
        execution_id:
          type: string
          title: Execution Id
          description: Execution identifier
        signal_type:
          type: string
          title: Signal Type
          description: Type of signal
          examples:
            - cache_hit
            - rerank_scores
            - filter_reduction
        signal_data:
          additionalProperties: true
          type: object
          title: Signal Data
          description: Signal-specific data
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: Additional metadata
      type: object
      required:
        - timestamp
        - execution_id
        - signal_type
        - signal_data
      title: RetrieverSignal
      description: Single retriever signal event.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````