Saltar al contenido

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

GET/api/reports/courses

Auth
Requiere token
Quién puede:
owner
admin
moderator
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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).

Parámetros

NombreDóndeTipoDescripción
intervalopcionalqueryday | 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.
fromopcionalquerystring (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`.
toopcionalquerystring (date)Último dia (inclusive), alargado até o fim do período. Padrão hoje.
timezoneopcionalquerystringFuso 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`.
pageopcionalqueryintegerPágina da lista detalhada (membros, eventos ou cursos).
limitopcionalqueryintegerItens por página da lista detalhada.

Headers

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

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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