Saltar al contenido

Relatório de engajamento (posts, comentários, reações e ranking)

GET/api/reports/engagement

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: `posts` (feed), `articles` (conteúdo), `comments`, `reactions`, `activeMembers` e `points` (pontos do ranking ganhos no período). `bySpace[]` reparte posts, comentários e reações pelo space onde aconteceram (`space: null` = fora de space). `members[]` é a lista paginada de quem mais engajou na janela, com `posts` (feed + conteúdo), `comments`, `reactions`, `interactions` (essas três + inscrições em evento e matrículas), `pointsInPeriod` e o `ranking` de hoje (pontos totais e nível). Ordem por `orderBy` (padrão `points` quando a gamificação está ligada, senão `interactions`). `unansweredPosts` lista os posts e conteúdos da janela que ninguém além do autor comentou.

`ranking` é o dado que gera o ranking: `enabled`, `rules[]` (pontos por ação), `series[]` com os pontos por período e por ação (uma coluna por tipo de ação), `byAction[]` (quantidade e pontos de cada ação na janela) e `levels[]` (quantos membros em cada nível hoje).

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`.
orderByopcionalquerypoints | interactions | posts | comments | reactions
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 pronta para gráfico; `pagination` vale para `members`.
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/engagement" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"