Aller au contenu

Resumo do dia da equipe (Dashboard)

GET/api/dashboard/summary

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
moderator
finance
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.

Instantâneo do dia para a equipe da comunidade (owner, admin, moderador e financeiro; os demais recebem 403). "Dia" e "semana" seguem o fuso da comunidade (`timeZone`). A resposta fica em cache por cerca de 30 segundos, por comunidade e por papel; `generatedAt` é o instante em que o resumo foi calculado.

Cada bloco só existe quando a comunidade tem o módulo: `bookings`, `visitors`, `presence` e `parcels`. `engagement` sempre existe. O bloco `money` vem **somente** para owner, admin e financeiro; para o moderador a chave não é devolvida. Um bloco que falhou volta `null` e os demais seguem. Engajamento: janela dos últimos 7 dias, mesma definição de "membro ativo" do relatório de engajamento. Nunca inclui custos do processador de pagamento.

En-têtes

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

Réponses

StatutDescription
200Resumo gerado.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemple curl

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