Pular para o conteúdo

Resumo do dia da equipe (Dashboard)

GET/api/dashboard/summary

Auth
Exige token
Quem pode:
owner
admin
moderator
finance
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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.

Headers

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

Respostas

CódigoDescrição
200Resumo gerado.
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.

Exemplo com curl

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