Get Cache Performance

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

{
  "retriever_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "cache_hit_rate": 0.5,
  "total_cache_hits": 123,
  "total_cache_misses": 123,
  "avg_cache_hit_latency_ms": 123,
  "avg_cache_miss_latency_ms": 123,
  "hourly_breakdown": [
    {}
  ]
}

Retrievers

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:

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"

GET

analytics

retrievers

{retriever_id}

cache-performance

Get Cache Performance

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

{
  "retriever_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "cache_hit_rate": 0.5,
  "total_cache_hits": 123,
  "total_cache_misses": 123,
  "avg_cache_hit_latency_ms": 123,
  "avg_cache_miss_latency_ms": 123,
  "hourly_breakdown": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retriever_id

string

required

Query Parameters

hours

integer

default:24

Hours of history

Required range: 1 <= x <= 720

Response

Successful Response

Cache performance metrics.

retriever_id

string

required

Retriever identifier

time_range

TimeRange · object

required

Time range

Show child attributes

cache_hit_rate

number

required

Overall cache hit rate

Required range: 0 <= x <= 1

total_cache_hits

integer

required

Total cache hits

total_cache_misses

integer

required

Total cache misses

avg_cache_hit_latency_ms

number

required

Average latency on cache hit

avg_cache_miss_latency_ms

number

required

Average latency on cache miss

hourly_breakdown

Hourly Breakdown · object[]

required

Hourly cache performance

Get Stage Breakdown Analyze For Tuning