VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Pulse (alertas)

Alertas automáticos de queda em faturamento, pedidos e aprovação de pagamento, com regras configuráveis.

O Pulse vigia os números da loja e avisa quando algo anda muito abaixo do normal: por exemplo, o faturamento da última hora caiu pela metade em relação a uma terça-feira típica. Isso costuma indicar um problema (checkout quebrado, gateway de pagamento fora do ar) que o lojista quer saber logo, e não no relatório do dia seguinte. Esta seção cobre as regras (o que vigiar e quão sensível) e os alertas (o que foi detectado).

Pontos principais
  • Há três métricas, uma lista fechada: revenue (faturamento), orders_count (pedidos) e payment_approval (aprovação de pagamento).
  • As regras padrão nascem desligadas; ligue as que quiser.
  • O Pulse avalia as regras ligadas a cada 15 minutos, comparando com a mediana das 4 últimas semanas na mesma hora e dia da semana.
  • Ler regras e alertas exige view_reports; criar, editar e apagar regras exige manage_settings.
  • As respostas de lista são arrays puros, sem objeto em volta.

Como funciona

A cada 15 minutos o Pulse mede a métrica na janela da regra (por exemplo, os últimos 60 minutos) e compara com o valor normal daquele horário. Se a queda chegar ao threshold_pct e houver volume suficiente (min_events), abre um alerta e avisa pelos canais da regra. Enquanto a condição durar dentro do cooldown_minutes (contado desde a primeira detecção), o mesmo alerta é apenas atualizado (last_seen_at) e ninguém é avisado de novo; passado esse prazo, se a queda continua, um novo alerta é aberto e o aviso sai outra vez. Quando a métrica volta ao normal por duas avaliações seguidas, o alerta passa a resolved.

open→acknowledged→resolved
Estado do alertaSignificado
openDetectado e ainda ativo.
acknowledgedAlguém da equipe marcou como visto (rota ack).
resolvedA métrica voltou ao normal.
MétricaO que mede
revenueSoma do valor dos pedidos na janela (centavos).
orders_countQuantidade de pedidos na janela.
payment_approvalTaxa de pagamentos aprovados entre os concluídos na janela.

Conceitos importantes

Baseline

O "normal" é a mediana do mesmo horário e dia da semana nas últimas 4 semanas, no fuso de São Paulo. Uma loja nova, sem histórico, não gera alertas até acumular dados.

Volume mínimo

min_events evita alarme falso em horários de pouco movimento: com poucos pedidos, uma oscilação normal parece uma queda enorme.

Canais e horário de silêncio

inbox coloca o aviso no sino do painel. whatsapp envia uma mensagem ao whatsapp_number (e exige o módulo de WhatsApp ativo). O horário de silêncio (quiet_start a quiet_end, que pode atravessar a meia-noite) adia só o WhatsApp; um alerta critical ignora o silêncio.

Severidade

warning para quedas a partir do limite; critical a partir de 80%.

Dinheiro e taxas

Valores em dinheiro vêm em centavos (impact_cents: 78000 = R$ 780,00). Taxas vêm em pontos-base (10000 = 100%).

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/admin/pulse/rulesLista as regras de alertaadmin
POST/api/v1/admin/pulse/rulesCria uma regra de alertaadmin
PUT/api/v1/admin/pulse/rulesAltera várias regras de uma vezadmin
DELETE/api/v1/admin/pulse/rules/{id}Remove uma regraadmin
GET/api/v1/admin/pulse/alertsLista os alertas disparadosadmin
POST/api/v1/admin/pulse/alerts/{id}/ackMarca um alerta como vistoadmin

Erros comuns

  • Mandar só {"id": ..., "is_active": true} no PUT: os outros campos são zerados.
  • Tentar criar regras com o PUT: itens sem id são ignorados; use o POST.
  • Criar uma métrica fora das três: recusado com unknown metric.
  • Criar duas regras com a mesma métrica e janela: a segunda é recusada.
  • Ler observed_cents de orders_count como dinheiro: é quantidade de pedidos.
  • Contar com o ack para confirmar a existência do alerta: ele responde 204 sempre.

Próximos passos

Regras
Listar, criar, editar e apagar.
Alertas
Listar e reconhecer.
Anterior
Listar perguntas sugeridas
Próxima
Regras do Pulse
Nesta página
  • Como funciona
  • Conceitos importantes
  • Baseline
  • Volume mínimo
  • Canais e horário de silêncio
  • Severidade
  • Dinheiro e taxas
  • Endpoints
  • Erros comuns
  • Próximos passos