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

GET/api/reports/engagement

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: `posts` (feed), `articles` (conteúdo), `comments`, `reactions`, `activeMembers` e `points` (pontos de engajamento 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 do Engajamento (pontos e níveis): `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).

`series[]` e `totals` trazem também `eventRegistrations`, `enrollments`, `lessons` (aulas abertas ou concluídas), `classifieds`, `galleryImages`, `eventsCreated` e `checkIns` (entradas no módulo Presença, só membros). `compare` traz os mesmos `totals` do período anterior de igual duração (`from`/`to` dele) e `deltaPct` por KPI: variação em %, `null` quando o anterior é zero. "Membro ativo" = ao menos uma atividade de qualquer tipo, inclusive anúncio, imagem de galeria, evento criado e check-in.

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