Vai al contenuto

Relatório de cursos (matrículas, progresso e conclusão)

GET/api/reports/courses

Auth
Richiede un token
Chi può:
owner
admin
moderator
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

F-46. Owner, admin ou moderador.

`series[]` por período: `enrollments`, `completions` (cursos concluídos) e `lessonsCompleted`. `courses[]` (paginada, mais matrículas primeiro) traz, por curso: `lessons`, `enrollments` (todas, sem as canceladas), `newEnrollments` e `completedInPeriod` (na janela), `completed`, `completionRate` (%) e `averageProgress` (% médio de aulas concluídas por matriculado; `null` sem matrícula).

Parametri

NomeDoveTipoDescrizione
intervalfacoltativoqueryday | week | monthTamanho de cada período da série. `week` começa na segunda-feira. Rótulo do período: `YYYY-MM-DD` (dia ou segunda-feira da semana) ou `YYYY-MM` (mês). Máximo de períodos por consulta: 366 dias, 156 semanas ou 120 meses.
fromfacoltativoquerystring (date)Primeiro dia (inclusive), no fuso do relatório, alargado para o início do período (com `interval=month`, `2026-03-15` vira `2026-03-01`). Padrão: 30 dias, 12 semanas ou 12 meses antes de `to`.
tofacoltativoquerystring (date)Último dia (inclusive), alargado até o fim do período. Padrão hoje.
timezonefacoltativoquerystringFuso IANA em que os períodos são contados. Padrão: o fuso do país da comunidade (o mesmo dos prazos do call4papers). A resposta devolve o fuso usado em `timezone`.
pagefacoltativoqueryintegerPágina da lista detalhada (membros, eventos ou cursos).
limitfacoltativoqueryintegerItens por página da lista detalhada.

Header

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

Risposte

CodiceDescrizione
200Série e lista de cursos; `pagination` vale para `courses`.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Esempio con curl

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