Métricas

Acesse as métricas e KPIs da sua academia em tempo real: membros ativos, MRR, churn, check-ins e ocupação.

Dashboard de Métricas

GET /api/v1/gym-metrics

Retorna um resumo completo dos indicadores de desempenho da academia.

Exemplo de Requisição

curl -X GET "https://dashboard.octagym.ai/api/v1/gym-metrics" \
  -H "Authorization: Bearer og_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

const response = await fetch(
  'https://dashboard.octagym.ai/api/v1/gym-metrics',
  {
    headers: {
      'Authorization': 'Bearer og_live_sua_chave_aqui',
      'Content-Type': 'application/json'
    }
  }
);

const data = await response.json();

Exemplo de Resposta

{
  "success": true,
  "data": {
    "active_members": 342,
    "total_members": 510,
    "trial_members": 18,
    "mrr_cents": 3420000,
    "churn_rate": 4.2,
    "cancelled_this_month": 15,
    "cancelled_last_month": 12,
    "checkins_today": 87,
    "checkins_this_month": 2340,
    "overdue_memberships": 23,
    "occupancy": {
      "current_count": 45,
      "max_capacity": 120
    }
  }
}

Campo	Tipo	Descrição
`active_members`	`int`	Membros com status ativo + trial
`total_members`	`int`	Total de membros cadastrados (todos os status)
`trial_members`	`int`	Membros em período de teste
`mrr_cents`	`int`	Receita recorrente mensal em centavos (BRL)
`churn_rate`	`float`	Taxa de churn mensal em porcentagem (%)
`cancelled_this_month`	`int`	Cancelamentos no mês atual
`cancelled_last_month`	`int`	Cancelamentos no mês anterior
`checkins_today`	`int`	Check-ins realizados hoje
`checkins_this_month`	`int`	Check-ins realizados no mês atual
`overdue_memberships`	`int`	Mensalidades com pagamento em atraso
`occupancy`	`object`	Ocupação atual da academia
`occupancy.current_count`	`int`	Pessoas presentes no momento
`occupancy.max_capacity`	`int`	Capacidade máxima configurada

O MRR (Monthly Recurring Revenue) é calculado considerando o período de cobrança de cada mensalidade ativa: mensal/1, trimestral/3, semestral/6, anual/12. Por exemplo, uma mensalidade anual de R$ 1.200 contribui com R$ 100/mês (1200/12) para o MRR.

Exemplos de Uso

Calculando a taxa de ocupação

const { data } = await response.json();
const occupancyRate = (data.occupancy.current_count / data.occupancy.max_capacity) * 100;
console.log(`Ocupação: ${occupancyRate.toFixed(1)}%`);
// Ocupação: 37.5%

Convertendo MRR de centavos para reais

const mrrReais = (data.mrr_cents / 100).toLocaleString('pt-BR', {
  style: 'currency',
  currency: 'BRL',
});
console.log(`MRR: ${mrrReais}`);
// MRR: R$ 34.200,00

Suporte

Email: suporte@octagym.ai
Dashboard: dashboard.octagym.ai

Métricas

Métricas

Dashboard de Métricas

Exemplo de Requisição

Exemplo de Resposta

Campos da Resposta

Exemplos de Uso

Calculando a taxa de ocupação

Convertendo MRR de centavos para reais

Suporte

On this page