Painel geral da comunidade, num pedido só

GET/api/reports/overview

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 finance; cada bloco segue a regra da sua área: `money` só para owner, admin e finance; `community` só para owner, admin, moderador e financeiro. O bloco que o papel não vê não vem na resposta.

Compara **este mês até agora** (`current`) com o mês passado inteiro (`previous`) e com o mês passado até o mesmo ponto (`previousToDate`, que é a base dos `...ChangePercent`). `money`: vendas (mesmo formato do relatório de vendas), `mrr`, `arr`, `payingSubscriptions` e a série de assinaturas dos dois meses. `money.byCurrency[]` traz uma linha por moeda em que a comunidade vendeu (`currency`, `revenue.current`, `revenue.previous`, `revenue.netChangePercent` e `balance` com `pending`, `retained`, `available` e `owed`); os blocos de cima seguem na moeda principal. `community`: membros (total e novos), engajamento (posts, comentários, reações, pontos, membros ativos) e eventos nos próximos 30 dias. Meses no fuso da comunidade (ou `timezone`).

Paramètres

Nom	Emplacement	Type	Description
`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`.

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`	Resumo do mês.
`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/overview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"