Dashboard, interações com clientes
Corresponde ao painel Interações com clientes da tela Dashboard. Mostra os
indicadores das interações com clientes já cadastrados: frequência, recência,
meios de contato, motivos e vínculo com propostas. Todos os endpoints são GET,
sem corpo.
Endpoints
| Método | Caminho | Indicador | Período (start_date, end_date) | Janela ou limite |
|---|---|---|---|---|
| GET | /crm/dashboard/interactions/interactions-over-time | Interações ao longo do tempo | Não | |
| GET | /crm/dashboard/interactions/by-mean-contact | Interações por meio de contato | Sim | |
| GET | /crm/dashboard/interactions/by-motive | Interações por motivo | Sim | |
| GET | /crm/dashboard/interactions/top-accounts | Clientes mais atendidos | Sim | 10 itens |
| GET | /crm/dashboard/interactions/risky-accounts | Clientes sem interação recente | Não | days_without_interaction, padrão 30; até 50 itens |
| GET | /crm/dashboard/interactions/recency-distribution | Distribuição de recência | Não | |
| GET | /crm/dashboard/interactions/by-user | Interações por vendedor ou usuário | Sim | 10 itens |
| GET | /crm/dashboard/interactions/with-proposal-kpi | Interações com proposta vinculada (KPI) | Sim | |
| GET | /crm/dashboard/interactions/with-proposal-trend | Interações com proposta vinculada (tendência) | Sim | |
| GET | /crm/dashboard/interactions/motive-proposal | Motivo × proposta | Sim | |
| GET | /crm/dashboard/interactions/mean-contact-proposal | Meio de contato × proposta | Sim | |
| GET | /crm/dashboard/interactions/by-contact | Interações por contato | Sim | 10 itens |
| GET | /crm/dashboard/interactions/high-frequency | Clientes com alta frequência de contato | Não | days_window, padrão 30; até 20 itens |
| GET | /crm/dashboard/interactions/heatmap-weekday | Mapa de calor semanal | Sim | |
| GET | /crm/dashboard/interactions/heatmap-hour | Mapa de calor por horário | Sim | |
| GET | /crm/dashboard/interactions/without-proposal | Clientes sem proposta vinculada | Não | days_without_proposal, padrão 30 |
Parâmetros
start_date e end_date (AAAA-MM-DD): limitam o período dos indicadores
marcados com Sim, pela data da interação. As duas datas são inclusivas. Se
nenhuma for informada, o indicador considera todo o histórico da empresa. Se só uma
for informada, o período fica aberto do outro lado.
days_without_interaction (inteiro, padrão 30): em Clientes sem interação
recente, quantidade mínima de dias desde a última interação para o cliente aparecer.
days_window (inteiro, padrão 30): em Clientes com alta frequência de
contato, tamanho em dias da janela de contagem das interações.
days_without_proposal (inteiro, padrão 30): em Clientes sem proposta
vinculada, quantidade mínima de dias desde a última interação com proposta
vinculada para o cliente aparecer. Clientes que nunca tiveram interação com proposta
também aparecem.
Os indicadores de "top" e de "por usuário" ou "por contato" têm limite fixo de itens, indicado na tabela.
Respostas
Os indicadores em gráfico respondem (200) com os dados do gráfico. O indicador de medida única responde com os campos abaixo:
| Indicador | Campos |
|---|---|
| Interações com proposta vinculada (KPI) | total_interactions, interactions_with_proposal, pct_with_proposal |
Listagem dos registros
GET /crm/dashboard/interactions lista as interações que compõem os indicadores.
Aceita os parâmetros da listagem de Interações com clientes.