> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Flywheel stats handler

> **Required scope:** read

**Required scope:** `read`

### Response

`FlywheelStats`

<ResponseField name="approved_candidates" type="integer" required />

<ResponseField name="auto_promoted" type="integer" required />

<ResponseField name="pending_candidates" type="integer" required />

<ResponseField name="processed_events" type="integer" required />

<ResponseField name="queued_events" type="integer" required />

<ResponseField name="rejected_candidates" type="integer" required />

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | Flywheel aggregate statistics                      |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.nsr.stateset.com/api/v1/flywheel/stats' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "approved_candidates": 1,
    "auto_promoted": 1,
    "pending_candidates": 1,
    "processed_events": 1,
    "queued_events": 1,
    "rejected_candidates": 1
  }
  ```
</ResponseExample>