Skip to main content

Export Learner Data

Authentication Required: PARENT or ADMIN role
GET /api/export
string
required
Learner ID to export data for

Authorization

  • PARENT: Can export data for their children only
  • ADMIN: Can export data for any learner
This endpoint is designed for data portability and compliance. It exports up to 1,000 lessons and all associated data.

Response Format

The response is a JSON file with the following structure:
object
Learner user object (password removed)
object
Complete learner profile including grade level, subjects, and knowledge graph
array
Array of up to 1,000 lesson records with full specifications and scores
array
Array of all earned achievements
string
ISO timestamp when the export was generated
number
User ID of the person who requested the export

Response Headers

The response includes special headers to trigger a file download:
The filename format is: learner-data-{learnerId}-{date}.json

Example Export

Export Example

Error Codes

  • 400 - learnerId is required
  • 401 - Unauthorized
  • 403 - Forbidden (parent can only export their own children)
  • 404 - Learner not found

Use Cases

Data Portability

Export learner data to move to another system or for archival purposes.

Compliance

Provide data export for GDPR, COPPA, or other privacy regulation compliance.

Backup

Create periodic backups of learner progress and achievements.

Analysis

Export data for offline analysis or reporting in external tools.
The export includes sensitive learner data. Ensure it’s stored and transmitted securely.