Dashboard
Corresponde à tela Dashboard do CRM. Ela mostra os indicadores do comercial em
três painéis: Lead empresarial, Lead de estudantes e Interações com
clientes. Os números são calculados com os dados da empresa cliente do usuário.
Os endpoints são somente leitura: cada indicador é um GET.
Cada painel tem uma página com os indicadores:
| Painel | Página |
|---|---|
| Lead empresarial (leads de empresas) | Lead empresarial |
| Lead de estudantes (leads de alunos) | Lead de estudantes |
| Interações com clientes | Interações com clientes |
Registros de cada painel
Cada painel tem também uma listagem dos registros que compõem os indicadores, usada
na tela para abrir a tabela de um gráfico. Essas listagens aceitam os mesmos
parâmetros de listagem de cada módulo, como search, per_page e page:
| Método | Caminho | Descrição |
|---|---|---|
| GET | /crm/dashboard/business-leads | Lista os leads de empresas do painel |
| GET | /crm/dashboard/student-leads | Lista os leads de alunos do painel |
| GET | /crm/dashboard/interactions | Lista as interações com clientes do painel |
As listagens do painel de leads de empresas e de interações seguem a mesma regra de visibilidade das telas correspondentes; veja Leads de empresas e Interações com clientes.
Parâmetros comuns
| Parâmetro | Descrição |
|---|---|
| start_date | Data inicial do período (AAAA-MM-DD). Vale nos indicadores marcados com Sim na página de cada painel |
| end_date | Data final do período (AAAA-MM-DD). Vale nos indicadores marcados com Sim na página de cada painel |
Os indicadores com janela de dias informam o parâmetro na própria página do painel.