Skip to main content
GET
/
v1
/
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: <authorization>' \
  --header 'X-Namespace: <x-namespace>'
{
  "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": [
    {}
  ]
}

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

​
X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

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

​
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