Progress API

​

Get Progress

​

Query Parameters

​

Response

​

Example Request

curl https://your-domain.com/api/progress?courseId=42

​

Example Response

{
  "progress": [
    {
      "id": 1,
      "user_id": "uuid-here",
      "course_id": 42,
      "lesson_id": 1,
      "completed": true,
      "video_progress": 0,
      "last_position": 0,
      "completed_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-15T09:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "user_id": "uuid-here",
      "course_id": 42,
      "lesson_id": 2,
      "completed": false,
      "video_progress": 145,
      "last_position": 145,
      "completed_at": null,
      "created_at": "2024-01-15T10:35:00Z",
      "updated_at": "2024-01-15T10:42:00Z"
    }
  ]
}

​

Update Progress

• Track video playback position
• Mark lessons as completed
• Update overall course progress

​

Request Body

​

Response

​

Example Request

curl -X POST https://your-domain.com/api/progress \
  -H "Content-Type: application/json" \
  -d '{
    "course_id": 42,
    "lesson_id": 2,
    "completed": false,
    "video_progress": 180,
    "last_position": 180
  }'

​

Example Response

{
  "progress": {
    "id": 2,
    "user_id": "uuid-here",
    "course_id": 42,
    "lesson_id": 2,
    "completed": false,
    "video_progress": 180,
    "last_position": 180,
    "completed_at": null,
    "created_at": "2024-01-15T10:35:00Z",
    "updated_at": "2024-01-15T10:50:00Z"
  }
}

​

Progress Tracking Logic

1. Check for existing record: Query by user_id + lesson_id
2. If exists: Update the record with new values
3. If not exists: Insert a new progress record
4. Return: The updated or created record

• No duplicate progress records
• Seamless updates without checking existence first
• Automatic progress resumption

​

Video Progress Tracking

• video_progress: Current playback position (updated frequently)
• last_position: Last saved position (for resume functionality)
• Allows users to resume from where they left off
• Progress is saved every few seconds during playback

​

Example: Video Resume Flow

1. User watches video to 180 seconds
2. Client sends: { video_progress: 180, last_position: 180 }
3. User closes browser
4. User returns to lesson
5. Client fetches progress: GET /api/progress?courseId=42
6. Client resumes video at last_position (180 seconds)

​

Lesson Completion

curl -X POST https://your-domain.com/api/progress \
  -H "Content-Type: application/json" \
  -d '{
    "course_id": 42,
    "lesson_id": 2,
    "completed": true
  }'

• Sets completed_at timestamp
• Updates enrollment progress percentage
• Checks if course is fully completed
• Triggers certificate generation (if enabled)

​

Course Completion Calculation

progress = (completed_lessons / total_required_lessons) * 100

1. Enrollment status → “completed”
2. Enrollment completed_at → current timestamp
3. Certificate generation triggered (if enabled)
4. Completion email sent

​

Progress States

​

Sequential Progress

• Users must complete lessons in order
• Can’t skip ahead to later lessons
• Progress API doesn’t enforce this (enforced in frontend)
• Backend only tracks completion state

​

Get Learner Progress (Admin)

​

Path Parameters

​

Query Parameters

​

Progress Analytics

• Course completion rates: % of enrolled users who complete
• Lesson difficulty: Lessons with low completion rates
• Drop-off points: Where users stop progressing
• Engagement metrics: Average video watch time
• Time to completion: Days from enrollment to completion

​

Error Codes