Skip to content

Números das campanhas no período

GET/api/campaigns/stats

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.

Owner, admin, moderador e financeiro. Soma todas as campanhas da comunidade, manuais e automáticas, nos últimos `days` dias (de 7 a 365; fora disso o valor é ajustado ao limite; padrão 30). Cada evento conta no dia em que aconteceu, no fuso da comunidade (o fuso do país dela, como no painel): entrega no dia da entrega, abertura e clique na primeira vez de cada e-mail, descadastro no dia em que o link foi usado. `recipients` é o público dos disparos que começaram no período. A série tem um ponto por dia, do mais antigo ao de hoje, com zero nos dias sem evento. `previous` traz os mesmos números do período de mesmo tamanho logo antes, e `compare` põe os dois lado a lado por métrica, com `deltaPct` (variação em %, uma casa; `null` quando o anterior é zero), como no `GET /api/dashboard/summary`. O resultado fica guardado por 30 segundos (`generatedAt` diz quando foi calculado). Nunca traz nome nem endereço.

Parameters

NameInTypeDescription
daysoptionalqueryinteger

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
200Totais e série diária.
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/campaigns/stats" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"