API ReferenceDashboard

List cache hit metrics

Returns semantic cache hit metrics (count, tokens, savings, hit %) as a time series.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Query parameters

summary_typeenumOptionalDefaults to all

Preset time range. Use this or explicit start_time / end_time.

datedateOptional

Base date used with summary_type presets.

start_timedatetimeOptional
Optional explicit ISO start time.
end_timedatetimeOptional
Optional explicit ISO end time.
time_tickenumOptionalDefaults to hour

Bucket granularity for time-series responses.

Allowed values:
timezone_offsetdoubleOptionalDefaults to 0
Timezone offset, in hours, used when resolving preset ranges.

Response

Successful response.
date_groupdatetime
cache_hit_countinteger
Number of requests served from cache.
cache_hit_tokensinteger
Tokens returned from cache.
cache_hit_cost_savingsdouble
Estimated cost saved.
cache_hit_percentagedouble

Cache hit rate (0-100).