john-okeefe
b44e4e4709
Clean up API documentation files by removing Phase X references: Remove 'API Explorer will be inserted here in Phase X' placeholders from: - 70+ API endpoint documentation files - Authentication endpoints (login, logout, register, refresh) - User endpoints (profile, settings, password) - Device endpoints (registration, sync, shelves) - Library endpoints (CRUD, folders, visibility) - Media endpoints (items, progress, highlights, notes) - Admin endpoints (users, analytics) - Sync endpoints (Kobo, KOReader) - OPDS endpoints - Scanner endpoints - Queue endpoints These placeholders were from planning documents and have no meaning to API consumers. The documentation is now clean and ready for use.
51 lines
1.0 KiB
Markdown
51 lines
1.0 KiB
Markdown
# Get Library Statistics
|
|
|
|
Get statistics for a specific library.
|
|
|
|
**Endpoint**: `GET /api/libraries/:id/stats`
|
|
**Auth**: Required (Admin only)
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| id | string (UUID) | Yes | Library UUID |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| Authorization | string | Yes | Bearer token (must have admin role) |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/libraries/550e8400-e29b-41d4-a716-446655440000/stats
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"library_id": "uuid",
|
|
"total_media_items": 1523,
|
|
"total_size_bytes": 5368709120,
|
|
"last_scan": "2026-02-08T10:00:00Z",
|
|
"formats": {
|
|
"epub": 1234,
|
|
"kepub": 189,
|
|
"mobi": 50,
|
|
"pdf": 50
|
|
}
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 401 | Invalid or expired token |
|
|
| 403 | User does not have admin privileges |
|
|
| 404 | Library not found |
|