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: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "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
}

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

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.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

retriever_id
string
required

Query Parameters

hours
integer
default:24

Hours of history

Required range: 1 <= x <= 720
func
string
required

Function reference (internal use only)

Response

Successful Response

Cache performance metrics.

retriever_id
string
required

Retriever identifier

time_range
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