Saltar para o conteúdo

Ranking do curso

GET/api/courses/{courseId}/leaderboard

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

F-06 fase 2. Os **10 primeiros** alunos por aulas concluídas no curso (empate: quem concluiu a última aula antes), com nome e avatar, e a posição de quem pede (`me`), mesmo fora do top 10. Sai de `lesson_progress`, não dos pontos. Só entram matrículas `enrolled` e `completed` e aulas vivas; quem saiu e a pré-visualização da equipe não entram. O top 10 fica em cache de **60 segundos** por curso; `me` é calculado na hora.

**Opt-in:** o ranking vem desligado; owner e admin ligam com `leaderboardEnabled: true` no curso. Desligado, **403**. Quem lê: a equipe (owner, admin, moderador, financeiro) e o aluno matriculado; os demais, 403.

Parâmetros

NomeOndeTipoDescrição
courseIdobrigatóriopathstring (uuid)

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respostas

CódigoDescrição
200O ranking.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemplo com curl

curl -X GET "https://api.memberfy.net/api/courses/<courseId>/leaderboard" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"