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

Insights e dicas

O que a Venddor Intelligence avisa sem ser perguntada: insights sobre os números, o briefing diário, alertas por tela e a análise de um registro.

Além de responder perguntas, a VI observa a loja e avisa o administrador do que merece atenção: estoque baixo, queda de receita, clientes que não voltaram. Há quatro mecanismos, com rotas próprias: os insights (cartões curtos por assunto), o briefing diário (a mensagem "Dicas do Dia", chamada de Venddor Pulse nas rotas), os alertas por tela (sugestões que aparecem conforme a página aberta) e a análise de um registro (produto, pedido ou cliente).

Pontos-chave
  • Tudo aqui é leitura e marcação: nenhuma rota desta seção altera produtos, pedidos ou preços.
  • Os insights e o briefing são gerados por rotinas diárias; run-now, run e backfill forçam a geração na hora e consomem recursos de IA.
  • Cada mecanismo tem um interruptor em Configurações: enable_proactive_insights, enable_venddor_pulse e proactive_nudges_enabled (este vem desligado por padrão).
  • O briefing é dividido por dia: uma edição por data civil (fuso de São Paulo), guardada por 90 dias.
  • Uma promoção sugerida no briefing é criada desativada: ninguém a ativa sem uma ação do administrador.

Como funciona

Quatro mecanismos

MecanismoQuem recebeComo chegaPáginas
InsightsUm administrador (target_user_id)Lista de cartões com assunto, gravidade e linkInsights, Ações
Briefing diárioTodos os administradores da lojaUma mensagem por dia, lida ou não lida por usuárioBriefing, Gerar
Alertas por telaO administrador na tela abertaSugestões calculadas na hora, a partir da telaAlertas
Análise de registroQuem pediuLista de sugestões para um produto, pedido ou clienteAnalisar

Gravidades

Um insight tem severity info (informativo), warning (atenção) ou opportunity (oportunidade).

Conceitos-chave

Privilégios

Insights, alertas e análise aceitam intelligence_use_chat ou view_reports. O briefing aceita view_reports ou manage_settings; gerar ou refazer o briefing exige manage_settings.

Datas

A data de um briefing (analysis_date) é uma data civil AAAA-MM-DD no fuso America/Sao_Paulo, não um instante em UTC. Os campos created_at são RFC 3339 em UTC.

Dados pessoais

A estrutura de tela enviada aos alertas passa por um filtro que remove e-mail, telefone, CPF e CNPJ antes de qualquer uso.

Rotas

Todas exigem Authorization: Bearer $TOKEN de um administrador.

MétodoCaminho (após /api/v1/admin/intelligence)Para que servePágina
GET/insightsListar os insights de quem chamainsights
GET/insights/historyHistórico da lojainsights
GET/insights/topicsAssuntos disponíveisinsights
POST/insights/run-nowGerar agorainsights-actions
PATCH/insights/{id}/seenMarcar como vistoinsights-actions
PATCH/insights/{id}/dismissDispensarinsights-actions
GET/venddor-pulseListar o briefing diáriopulse
GET/venddor-pulse/{id}Ler uma ediçãopulse
GET/venddor-pulse/unread-countContar não lidaspulse
POST/venddor-pulse/{id}/readMarcar como lidapulse
DELETE/venddor-pulse/{id}/readMarcar como não lidapulse
POST/venddor-pulse/runGerar uma ediçãopulse-run
POST/venddor-pulse/backfillGerar dias anteriorespulse-run
POST/triggers/evaluateAlertas para a tela atualtriggers
POST/triggers/proactive-messageDica proativa na conversatriggers
GET/POST/analyze-entityAnalisar um registroanalyze-entity

Erros comuns

  • Chamar run-now com o recurso desligado. Sem enable_proactive_insights a rota responde 403.
  • Esperar alertas por tela de uma loja nova. proactive_nudges_enabled nasce desligado; evaluate devolve lista vazia até alguém ligar.
  • Tratar o briefing como lista só de pronto. A lista inclui edições ainda em geração (generating) ou que falharam (failed). Filtre por generation_status.
  • Chamar venddor-pulse/run sem querer perder a edição do dia. Por padrão force é true e a edição do dia é apagada e refeita.
  • Paginar o histórico de insights além de 100. O histórico tem teto de 100 itens no total; offset a partir de 100 devolve vazio.
  • Esperar 404 ao marcar um insight inexistente. As marcações respondem 200 mesmo assim.

Próximos passos

Insights
A caixa de insights do administrador.
Briefing diário
As Dicas do Dia, lidas e não lidas.
Alertas por tela
Sugestões conforme a página aberta.
Analisar um registro
Produto, pedido ou cliente.
Anterior
Publicar, buscar e reindexar
Próxima
Insights proativos
Nesta página
  • Como funciona
  • Quatro mecanismos
  • Gravidades
  • Conceitos-chave
  • Privilégios
  • Datas
  • Dados pessoais
  • Rotas
  • Erros comuns
  • Próximos passos