Saltar al contenido

Números das campanhas no período

GET/api/campaigns/stats

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Parámetros

NombreDóndeTipoDescripción
daysopcionalqueryinteger

Headers

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

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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