> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://respan.ai/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://respan.ai/docs/_mcp/server.

# Get cache hit summary

POST https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/

Returns cache hit metrics aggregated over the time range.

Reference: https://respan.ai/docs/apis/metrics/get-cache-hit-summary

## Authentication

- `Authorization` header (bearer token, required) — 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.
- `Authorization` header (bearer token, required) — Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

## Request

### Query parameters

- `summary_type` (enum, optional, default: all) — Preset time range. Use this or explicit `start_time` / `end_time`.
  - Allowed values: `daily`, `weekly`, `monthly`, `quarterly`, `yearly`, `last_24h`, `all`
- `date` (date, optional) — Base date used with `summary_type` presets.
- `start_time` (datetime, optional) — Optional explicit ISO start time.
- `end_time` (datetime, optional) — Optional explicit ISO end time.
- `time_tick` (enum, optional, default: hour) — Bucket granularity for time-series responses.
  - Allowed values: `minute`, `hour`, `day`
- `timezone_offset` (double, optional, default: 0) — Timezone offset, in hours, used when resolving preset ranges.

## Response

### 200

Successful response.

- `summary` (DashboardCacheHitSummary, required)

## Errors

### 403 Forbidden Error

The API key is missing, invalid or expired.

- `detail` (string, required)

## Types

### DashboardCacheHitSummary

- `number_of_requests` (integer, optional)
- `total_prompt_tokens` (integer, optional)
- `total_completion_tokens` (integer, optional)
- `total_tokens` (integer, optional)
- `total_time_saved` (double, optional)
- `total_cost` (double, optional)

## Examples

**Response**

```json
{
  "summary": {
    "number_of_requests": 1,
    "total_prompt_tokens": 1,
    "total_completion_tokens": 1,
    "total_tokens": 1,
    "total_time_saved": 1.1,
    "total_cost": 1.1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/"

headers = {"Authorization": "Bearer <respanApiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/';
const options = {method: 'POST', headers: {Authorization: 'Bearer <respanApiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <respanApiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <respanApiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/")
  .header("Authorization", "Bearer <respanApiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/', [
  'headers' => [
    'Authorization' => 'Bearer <respanApiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <respanApiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <respanApiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.respan.ai/api/dashboard/cache-hit-metrics/summary/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```