Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sunschool.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Reports

Authentication Required: Any authenticated user with access to the learner
GET /api/reports
curl -X GET https://api.sunschool.xyz/api/reports?learnerId=3&type=progress \
  -H "Authorization: Bearer {token}"
​
learnerId
string
required
Learner ID to generate report for
​
type
string
Report type: all, progress, lessons, or achievements (default: all)

​
Authorization

  • ADMIN: Can generate reports for any learner
  • PARENT: Can generate reports for their children
  • LEARNER: Can generate their own report

​
Progress Report (type=progress or type=all)

​
Response

​
learner
object
Learner user object (without password)
​
profile
object
Learner profile with subjects and grade level
​
analytics
object
​
subjectPerformance
object
Performance metrics by subject
​
reportGeneratedAt
string
ISO timestamp of report generation
Progress Report Example
{
  "learner": {
    "id": 3,
    "username": "alice-123456",
    "name": "Alice",
    "email": "alice@example.com",
    "role": "LEARNER",
    "parentId": 1
  },
  "profile": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "3",
    "gradeLevel": 5,
    "subjects": ["Math", "Science", "Reading"],
    "subjectPerformance": {
      "Math": {"averageScore": 85, "lessonsCompleted": 12},
      "Science": {"averageScore": 92, "lessonsCompleted": 8}
    },
    "recommendedSubjects": ["History"],
    "strugglingAreas": ["Fractions"]
  },
  "analytics": {
    "lessonsCompleted": 20,
    "lessonsActive": 1,
    "lessonsQueued": 0,
    "totalLessons": 21,
    "achievementsCount": 5,
    "conceptsLearned": 42,
    "progressRate": 95.24,
    "subjectDistribution": {
      "Math": 12,
      "Science": 8,
      "Reading": 1
    }
  },
  "subjectPerformance": {
    "Math": {"averageScore": 85, "lessonsCompleted": 12},
    "Science": {"averageScore": 92, "lessonsCompleted": 8}
  },
  "reportGeneratedAt": "2024-01-15T10:30:00.000Z"
}

​
Lessons Report (type=lessons)

​
Response

​
lessons
array
Array of all lessons for the learner
​
reportGeneratedAt
string
ISO timestamp of report generation
Lessons Report Example
{
  "lessons": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "learnerId": 3,
      "subject": "Math",
      "status": "DONE",
      "score": 85,
      "difficulty": "beginner",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "learnerId": 3,
      "subject": "Science",
      "status": "DONE",
      "score": 92,
      "difficulty": "beginner",
      "createdAt": "2024-01-14T09:15:00.000Z"
    }
  ],
  "reportGeneratedAt": "2024-01-15T10:30:00.000Z"
}

​
Achievements Report (type=achievements)

​
Response

​
achievements
array
Array of all achievements earned by the learner
​
reportGeneratedAt
string
ISO timestamp of report generation
Achievements Report Example
{
  "achievements": [
    {
      "id": "ach_123456",
      "learnerId": "3",
      "type": "FIRST_PERFECT",
      "payload": {
        "title": "Perfect Score!",
        "description": "Got 100% on your first quiz",
        "icon": "🌟"
      },
      "earnedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "reportGeneratedAt": "2024-01-15T10:30:00.000Z"
}

​
Error Codes

  • 400 - learnerId is required
  • 400 - Invalid report type
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Learner not found
  • 500 - Failed to generate report

​
Use Cases

​
Parent Dashboard

Use type=progress to get comprehensive analytics for displaying on a parent dashboard: 
GET /api/reports?learnerId=3&type=progress

​
Detailed Lesson History

Use type=lessons to get a full list of all lessons completed: 
GET /api/reports?learnerId=3&type=lessons
Use type=achievements to display all earned achievements: 
GET /api/reports?learnerId=3&type=achievements

​
Complete Data Export

Use type=all (or omit the type parameter) to get everything: 
GET /api/reports?learnerId=3&type=all
The conceptsLearned metric is calculated from the mastery service and represents unique concepts the learner has encountered across all lessons.