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.
46 lines
1002 B
Markdown
46 lines
1002 B
Markdown
# Get Reading Statistics
|
|
|
|
Retrieve reading statistics for a date range.
|
|
|
|
**Endpoint**: `GET /api/analytics/reading-stats`
|
|
**Auth**: Required
|
|
|
|
## Query Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| start_date | string | No | Start date (ISO 8601 format) |
|
|
| end_date | string | No | End date (ISO 8601 format) |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| Authorization | string | Yes | Bearer token |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/analytics/reading-stats?start_date=2026-01-01&end_date=2026-01-31
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"pages_read": 1250,
|
|
"books_completed": 5,
|
|
"reading_time_hours": 42.5,
|
|
"sessions_count": 28,
|
|
"average_session_minutes": 91
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid date format |
|
|
| 401 | Invalid or expired token |
|