---
title: "Get a site's Varnish statistics"
url: https://docs.corefinity.com/api/reference/varnish/get-site-varnish-stats
type: endpoint
last_updated: 2026-11-13
feature: varnish
related:
  - https://docs.corefinity.com/guides/sites/software-and-services/varnish.md
  - https://docs.corefinity.com/mcp/tools/corestack_varnish_stats.md
---
# Get a site's Varnish statistics

Answers the cache's figures over the last hour, day or week, in equal steps: hits, misses, requests, the hit ratio, cached pages and memory, with the totals and the recent purges. `available` is false, with a `reason`, until the site has been sampled.

```http
GET /api/corestack/sites/{site}/varnish/stats
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Query parameters

- `range` (string): How far back.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The statistics. `buckets` is shortened here.

```json
{
  "available": true,
  "bucket_seconds": 3600,
  "buckets": [
    {
      "at": "2026-11-06T08:00:00Z",
      "backend_errors": 0,
      "backend_fetches": 840,
      "bytes_free": 402653184,
      "bytes_used": 268435456,
      "evictions": 0,
      "hit_ratio": 0.9,
      "hits": 5400,
      "misses": 600,
      "objects": 4200,
      "passes": 240,
      "requests": 6240,
      "requests_per_s": 1.73,
      "reset": false,
      "samples": 12,
      "storage_bytes": 671088640,
      "transient_bytes": 1048576
    }
  ],
  "from": "2026-11-05T09:00:00Z",
  "hosts": [
    "harbourandfinch.example.com",
    "www.harbourandfinch.example.com"
  ],
  "purges_this_hour": {
    "available_at": null,
    "limit": 10,
    "used": 1
  },
  "range": "24h",
  "reason": null,
  "recent_purges": [
    {
      "at": "2026-11-06T09:16:40Z",
      "by": {
        "name": "Eleanor Finch"
      },
      "confirmed": true,
      "hosts": [],
      "id": 905,
      "item_count": 2,
      "items": [
        "cat_p_1180",
        "cat_c_27"
      ],
      "mode": "tags",
      "reference": null,
      "source": "person",
      "status": "succeeded",
      "trigger": null,
      "via": "api"
    },
    {
      "at": "2026-11-06T08:41:07Z",
      "by": null,
      "confirmed": true,
      "hosts": [],
      "id": 902,
      "item_count": 0,
      "items": [],
      "mode": "all",
      "reference": 4821,
      "source": "deployment",
      "status": "succeeded",
      "trigger": "deployment",
      "via": null
    }
  ],
  "sampled_at": "2026-11-06T08:55:00Z",
  "stale": false,
  "to": "2026-11-06T09:00:00Z",
  "totals": {
    "backend_errors": 0,
    "backend_fetches": 20160,
    "bytes_free": 402653184,
    "bytes_used": 268435456,
    "evictions": 0,
    "hit_ratio": 0.9,
    "hit_ratio_7d": 0.88,
    "hits": 129600,
    "misses": 14400,
    "missing": [],
    "objects": 4200,
    "pass_ratio": 0.04,
    "passes": 5760,
    "peak_requests_per_s": 6.2,
    "requests": 149760,
    "requests_per_s": 1.73,
    "resets": 0,
    "storage_bytes": 671088640,
    "transient_bytes": 1048576
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The site is not a Magento 2 site (`varnish_not_offered`), or Varnish is off (`varnish_off`).

```json
{
  "code": "varnish_not_offered",
  "message": "Varnish is available for Magento 2 sites only.",
  "reason": "varnish_not_offered"
}
```

### 422 `range` is not one of the three (`invalid`).

```json
{
  "code": "invalid",
  "errors": {
    "range": [
      "range must be 1h, 24h or 7d."
    ]
  },
  "field": "range",
  "message": "range must be 1h, 24h or 7d.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 409 | `varnish_not_offered` | Varnish is available for Magento 2 sites only. Nothing to change here. |
| 409 | `varnish_off` | Varnish is off on the environment. Switch it on first. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Varnish](https://docs.corefinity.com/guides/sites/software-and-services/varnish.md)
- MCP tool: [`corestack_varnish_stats`](https://docs.corefinity.com/mcp/tools/corestack_varnish_stats.md)
