---
title: "Get Book Stats"
method: GET
path: "/Books/Stats"
tags: ["Books"]
---

# Get Book Stats

`GET /Books/Stats`

**Requires permissions:** *StaffMember* or *Student*

Get Book Stats for a particular type; the type can be one of the following: Admin, Form, Student, Class, House, HoD. These should be paired with the filter parameter, e.g. if type is 'Student' and filter is '1234567890' then the books for the student with the UPI '1234567890' will be returned.

## Query parameters

- `type` string, nullable
- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Response `200`

Success - Success

- GetBookStatsResponse
  - `stats` BookReadingStats
    - `books` integer
    - `booksVerified` integer
    - `booksCommended` integer
    - `booksDistinction` integer
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Explain Error
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/fab57bf5558a/schema)