Painel geral da comunidade, num pedido só
GET/api/reports/overview
- Auth
- Exige token
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
F-46. 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 e moderador. 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. `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`).
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
timezoneopcional | 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`. |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
200 | Resumo do mês. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/reports/overview" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"