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

GET/api/reports/courses

Auth: Jeton requis
Clé d’API:: reports:read
X-CommunityId: X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.

Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Owner, admin, moderador ou financeiro.

`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), `averageRating` (média das estrelas dadas às aulas existentes, uma casa decimal; `null` sem avaliação) e `ratingsCount`. O detalhe por aula, com a distribuição e os comentários, está em `GET /api/courses/{courseId}/ratings`.

Paramètres

Nom	Emplacement	Type	Description
`interval`facultatif	query	`day \| week \| month`	Tamanho 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.
`from`facultatif	query	`string (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`.
`to`facultatif	query	`string (date)`	Último dia (inclusive), alargado até o fim do período. Padrão hoje.
`timezone`facultatif	query	`string`	Fuso 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`.
`page`facultatif	query	`integer`	Página da lista detalhada (membros, eventos ou cursos).
`limit`facultatif	query	`integer`	Itens por página da lista detalhada.

En-têtes

Nom	Type	Description
`X-CommunityId`facultatif	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

Statut	Description
`200`	Série e lista de cursos; `pagination` vale para `courses`.
`400`	Requisição inválida — falha de validação.
`401`	Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
`403`	Autenticado, mas sem permissão para esta operação.
`500`	Erro interno do servidor.

Exemple curl

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