Pular para o conteúdo principal

Estatísticas de Analytics

Retorna métricas detalhadas de crescimento, engajamento e tendências do seu bot. Este endpoint fornece dados comparativos (diários, semanais e mensais) úteis para entender o impacto de atualizações e campanhas.

Endpoint

| GET | /api/v1/bots/:botId/analytics | Sim (Bearer) | Básico (Padrão) |

URL Completa: https://botgate-api-987684559046.us-central1.run.app/api/v1/bots/:botId/analytics

Parâmetros de URL

ParâmetroTipoDescrição
botIdStringO ID do bot no Discord.

Resposta de Sucesso

{
"success": true,
"data": {
"botId": "1234567890123456789",
"botName": "BotTeste",
"growth": {
"servers": {
"current": 4,
"today": 0,
"week": 0,
"month": 0,
"percentageChange": {
"daily": "0.0",
"weekly": "0.0",
"monthly": "0.0"
}
},
"users": {
"current": "273",
"estimated": "273"
},
"votes": {
"current": 0,
"today": 0,
"week": 0,
"month": 0,
"percentageChange": {
"daily": 0,
"weekly": 0,
"monthly": 0
}
}
},
"engagement": {
"votesPerDay": 0,
"reviewsPerWeek": 0,
"averageRating": 0,
"totalReviews": 0,
"monthlyVotes": 0
},
"trends": {
"peakDays": [],
"dailyVotesLast7Days": []
},
"metadata": {
"botAge": {
"days": 0,
"months": 0
},
"dataQuality": {
"hasYesterdayData": false,
"hasWeekData": false,
"hasMonthData": false
}
}
}
}

O que este endpoint faz?

  1. Cálculo de Crescimento: Compara os dados atuais do seu bot com os registros históricos salvos pelo sistema (ontem, 7 dias atrás e 30 dias atrás).
  2. Métricas de Engajamento: Calcula a média de votos diários e reviews semanais.
  3. Análise de Tendências: Identifica os dias da semana em que seu bot costuma receber mais votos.
Registro de Dados

Para que este endpoint retorne dados comparativos precisos, é essencial que seu bot envie estatísticas regularmente via o endpoint /bots/stats. Sem histórico, as mudanças aparecerão como 0.

Se estiver usando o pacote NPM, basta chamar reporter.getBotAnalytics() para obter este objeto completo.