Get Reports
Authentication Required: Any authenticated user with access to the learner
GET /api/reports
string
required
Learner ID to generate report for
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
object
Learner user object (without password)
object
Learner profile with subjects and grade level
object
object
Performance metrics by subject
string
ISO timestamp of report generation
Progress Report Example
Lessons Report (type=lessons)
Response
array
Array of all lessons for the learner
string
ISO timestamp of report generation
Lessons Report Example
Achievements Report (type=achievements)
Response
array
Array of all achievements earned by the learner
string
ISO timestamp of report generation
Achievements Report Example
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
Usetype=progress to get comprehensive analytics for displaying on a parent dashboard:
Detailed Lesson History
Usetype=lessons to get a full list of all lessons completed:
Achievement Gallery
Usetype=achievements to display all earned achievements:
Complete Data Export
Usetype=all (or omit the type parameter) to get everything:
The
conceptsLearned metric is calculated from the mastery service and represents unique concepts the learner has encountered across all lessons.