Skip to main content

Заголовки запроса

Authorization
string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
Seller-Id
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
School-Id
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
GET /saas/v2/course/:courseId/progresses
Возвращает записи прогресса по урокам выбранного курса для всех участников. Каждая запись соответствует паре «пользователь + урок».

Параметры пути

courseId
integer
required
ID курса, прогресс по которому нужно получить.

Параметры запроса

Пагинация

skip
integer
Количество записей, которые нужно пропустить. По умолчанию 0.
page
integer
Номер страницы (альтернатива skip). Начинается с 1.
take
integer
Количество записей на странице. От 1 до 1000. По умолчанию 100.

Поля ответа

payload
object
Постраничный список записей прогресса. Полная структура записи — courseProgress в справочнике course.
curl --location 'https://api.exode.biz/saas/v2/course/10/progresses?take=50' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Authorization: Bearer YOUR_TOKEN'
{
  "success": true,
  "code": 200,
  "payload": {
    "page": 1,
    "count": 1,
    "pages": 1,
    "isFirst": true,
    "isLast": true,
    "items": [
      {
        "id": 9001,
        "courseId": 10,
        "userId": 123,
        "lessonId": 55,
        "status": "Completed",
        "scheduleStatus": "InProgress",
        "isCompleted": true,
        "completedAt": "2025-01-15T10:30:00Z",
        "createdAt": "2025-01-10T09:00:00Z",
        "updatedAt": "2025-01-15T10:30:00Z"
      }
    ],
    "next": {
      "skip": 20,
      "take": 20,
      "page": 2
    },
    "prev": {
      "skip": 0,
      "take": 20,
      "page": 1
    }
  }
}

Требования к правам доступа

Требуется аутентификация по токену и одно из прав: куратор курса (CourseCurator) или управление пользователями школы (SchoolManageUsers).