> ## 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 Cache Performance

> Get cache performance metrics.

Analyzes cache effectiveness including:
- Hit/miss rates
- Latency comparison (cache vs full search)
- Hourly cache performance trends

**Use Cases:**
- Evaluate cache effectiveness
- Optimize cache TTL settings
- Monitor cache performance
- Identify cache warming opportunities

**Example:**
```bash
curl -X GET "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/cache-performance?hours=168" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"
```



## OpenAPI

````yaml get /v1/analytics/retrievers/{retriever_id}/cache-performance
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}/cache-performance:
    get:
      tags:
        - Analytics
        - Analytics - Retrievers
      summary: Get Cache Performance
      description: >-
        Get cache performance metrics.


        Analyzes cache effectiveness including:

        - Hit/miss rates

        - Latency comparison (cache vs full search)

        - Hourly cache performance trends


        **Use Cases:**

        - Evaluate cache effectiveness

        - Optimize cache TTL settings

        - Monitor cache performance

        - Identify cache warming opportunities


        **Example:**

        ```bash

        curl -X GET
        "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/cache-performance?hours=168"
        \
          -H "Authorization: Bearer YOUR_API_KEY" \
          -H "X-Namespace: your-namespace"
        ```
      operationId: >-
        get_cache_performance_v1_analytics_retrievers__retriever_id__cache_performance_get
      parameters:
        - name: retriever_id
          in: path
          required: true
          schema:
            type: string
            title: Retriever Id
        - 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:
                $ref: '#/components/schemas/CachePerformanceResponse'
        '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:
    CachePerformanceResponse:
      properties:
        retriever_id:
          type: string
          title: Retriever Id
          description: Retriever identifier
        time_range:
          $ref: '#/components/schemas/api__analytics__models__TimeRange'
          description: Time range
        cache_hit_rate:
          type: number
          maximum: 1
          minimum: 0
          title: Cache Hit Rate
          description: Overall cache hit rate
        total_cache_hits:
          type: integer
          title: Total Cache Hits
          description: Total cache hits
        total_cache_misses:
          type: integer
          title: Total Cache Misses
          description: Total cache misses
        avg_cache_hit_latency_ms:
          type: number
          title: Avg Cache Hit Latency Ms
          description: Average latency on cache hit
        avg_cache_miss_latency_ms:
          type: number
          title: Avg Cache Miss Latency Ms
          description: Average latency on cache miss
        hourly_breakdown:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Hourly Breakdown
          description: Hourly cache performance
      type: object
      required:
        - retriever_id
        - time_range
        - cache_hit_rate
        - total_cache_hits
        - total_cache_misses
        - avg_cache_hit_latency_ms
        - avg_cache_miss_latency_ms
        - hourly_breakdown
      title: CachePerformanceResponse
      description: Cache performance metrics.
      examples:
        - avg_cache_hit_latency_ms: 5.2
          avg_cache_miss_latency_ms: 145.8
          cache_hit_rate: 0.78
          hourly_breakdown:
            - hit_rate: 0.78
              hits: 145
              hour: '2025-10-28T10:00:00Z'
              misses: 42
          retriever_id: ret_abc123
          time_range:
            end: '2025-10-29T00:00:00Z'
            start: '2025-10-28T00:00:00Z'
          total_cache_hits: 3456
          total_cache_misses: 978
    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
    api__analytics__models__TimeRange:
      properties:
        start:
          type: string
          format: date-time
          title: Start
          description: Start time (UTC)
        end:
          type: string
          format: date-time
          title: End
          description: End time (UTC)
      type: object
      required:
        - start
        - end
      title: TimeRange
      description: Time range for analytics queries.
    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

````