Get cache hits over time
https://api.respan.ai/api/dashboard/cache-hit-metrics/Returns semantic cache hit metrics (count, tokens, savings, hit %) as a time series.
Servers
https://api.respan.ai: Respan API Server
Authentication
RespanApiKey
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, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.
HTTP scheme: bearer; format: Respan API key.
Authorization: Bearer $RESPAN_API_KEYOr:
DashboardJwt
Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.
HTTP scheme: bearer; format: Dashboard JWT.
Authorization: Bearer $RESPAN_DASHBOARD_JWTQuery parameters
summary_type string Optionalstart_time / end_time.Allowed:
"daily", "weekly", "monthly", "quarterly", "yearly", "last_24h", "all"Default:
alldate string Optionalsummary_type presets.Format:
datestart_time string OptionalFormat:
date-timeend_time string OptionalFormat:
date-timetime_tick string OptionalAllowed:
"minute", "hour", "day"Default:
hourtimezone_offset number OptionalDefault:
0Responses
200
Successful response.
application/json
$ object Body
data array<object> Required in parent
data[] object Array item
#/components/schemas/DashboardCacheHitRowdata[].date_group string Optionaldate-timedata[].number_of_requests integer or null Optionaldata[].total_prompt_tokens integer or null Optionaldata[].total_completion_tokens integer or null Optionaldata[].total_tokens integer or null Optionaldata[].total_time_saved number or null Optionaldata[].total_cost number or null OptionalOpenAPI response schema
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardCacheHitRow"
}
}
}
}403
The API key is missing, invalid or expired.
application/json
$ object Body
detail string Required in parentOpenAPI response schema
{
"type": "object",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string"
}
}
}Example
{
"detail": "Your API key is invalid or expired, please check your API key in the platform settings."
}OpenAPI source
The operation and referenced components below retain the complete OpenAPI definitions, including constraints and examples.
OpenAPI operation
{
"summary": "Get cache hits over time",
"operationId": "listCacheHitMetrics",
"tags": [
"Dashboard"
],
"description": "Returns semantic cache hit metrics (count, tokens, savings, hit %) as a time series.",
"parameters": [
{
"name": "summary_type",
"in": "query",
"schema": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly",
"quarterly",
"yearly",
"last_24h",
"all"
],
"default": "all"
},
"description": "Preset time range. Use this or explicit `start_time` / `end_time`."
},
{
"name": "date",
"in": "query",
"schema": {
"type": "string",
"format": "date"
},
"description": "Base date used with `summary_type` presets."
},
{
"name": "start_time",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Optional explicit ISO start time."
},
{
"name": "end_time",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Optional explicit ISO end time."
},
{
"name": "time_tick",
"in": "query",
"schema": {
"type": "string",
"enum": [
"minute",
"hour",
"day"
],
"default": "hour"
},
"description": "Bucket granularity for time-series responses."
},
{
"name": "timezone_offset",
"in": "query",
"schema": {
"type": "number",
"default": 0
},
"description": "Timezone offset, in hours, used when resolving preset ranges."
}
],
"responses": {
"200": {
"description": "Successful response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardCacheHitRow"
}
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/InvalidApiKey"
}
},
"security": [
{
"RespanApiKey": []
},
{
"DashboardJwt": []
}
]
}OpenAPI path metadata
{}Referenced OpenAPI components
{
"responses": {
"InvalidApiKey": {
"description": "The API key is missing, invalid or expired.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string"
}
}
},
"example": {
"detail": "Your API key is invalid or expired, please check your API key in the platform settings."
}
}
}
}
},
"schemas": {
"DashboardCacheHitRow": {
"type": "object",
"properties": {
"date_group": {
"type": "string",
"format": "date-time"
},
"number_of_requests": {
"type": "integer",
"nullable": true
},
"total_prompt_tokens": {
"type": "integer",
"nullable": true
},
"total_completion_tokens": {
"type": "integer",
"nullable": true
},
"total_tokens": {
"type": "integer",
"nullable": true
},
"total_time_saved": {
"type": "number",
"nullable": true
},
"total_cost": {
"type": "number",
"nullable": true
}
}
}
},
"securitySchemes": {
"DashboardJwt": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Dashboard JWT",
"description": "Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.",
"x-fern-bearer": {
"name": "dashboardJwt",
"env": "RESPAN_DASHBOARD_JWT"
}
},
"RespanApiKey": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Respan API key",
"description": "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, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.",
"x-fern-bearer": {
"name": "respanApiKey",
"env": "RESPAN_API_KEY"
}
}
}
}