Skip to content

Painel geral da comunidade, num pedido só

GET/api/reports/overview

Auth
Requires a token
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

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

Parameters

NameInTypeDescription
timezoneoptionalquerystringFuso 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

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

Responses

StatusDescription
200Resumo do mês.
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.

curl example

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