Aller au contenu

Visão geral do analytics da comunidade

GET/api/analytics/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 e admin. Período em dias do fuso da comunidade (`from`/`to` inclusivos, padrão os últimos 30 dias, até 366). Dias fechados vêm do resumo diário; o dia corrente (e o que o job ainda não fechou) vem do bruto, então um pageview aparece em até 1 minuto.

`totals`: `pageviews`, `visits` (**visitas**: soma dos visitantes únicos de cada dia, não pessoas únicas do período), `sessions`, `memberVisits`, `anonymousSessions`, `avgTimeOnPageSeconds` (tempo até o próximo pageview da sessão, até 30 min; null sem amostra). `previousTotals`: o período anterior de mesmo tamanho. `series[]` por dia, `topSpaces[]`, `topPages[]`, `referrers[]` (`host` null = direto), `utmSources[]`, `countries[]`, `devices[]`. Só tráfego humano. `robots`: quadro separado de buscadores e LLMs (`search[]`, `llm[]`, `topPaths[]`) e `discarded` (robô ruim e excesso de eventos).

Paramètres

NomEmplacementTypeDescription
fromfacultatifquerystring (date)
tofacultatifquerystring (date)
limitfacultatifqueryintegerItens em cada lista.

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
200Visão geral.
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/analytics/overview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"