Dashboard

1 função do TermoSell para dashboard.

// npm install termo_core --save-exact
import * as sell from "termo_core/sell";
// ou: import { sell } from "termo_core";
FunçãoRotaO que faz
buscar_pelo_filtro_dashboardGET /dashboard/filtroIndicadores gerenciais do atendimento

buscar_pelo_filtro_dashboard

GET/dashboard/filtro Exige credencial

Indicadores gerenciais do atendimento

Exige qualquer permissão da área clientes (qualquer ação liberada na área já libera a leitura). Monta o painel do atendimento a partir do histórico interno de conversas. dias é o período (padrão 30, entre 1 e 365) contado em dias inteiros no horário de Brasília, de inicio até agora; robo_id (opcional) limita às conversas de um robô. indicadores traz as conversas novas do período e do período anterior de mesmo tamanho, as conversas e os clientes com mensagem do contato no período, as mensagens recebidas, do robô e da equipe, as conversas novas que passaram para a equipe (transferidas, abertas ou com mensagem de atendente), as resolvidas só pelo robô, as transferidas pelo gatilho de cliente sem resposta, as conversas em aberto cuja última mensagem é do contato e a mediana, em segundos, da primeira resposta (qualquer lado) e da primeira resposta da equipe. situacao_atual conta todas as conversas por status, sem recorte de período. por_dia e por_hora distribuem as mensagens no horário de Brasília; por_robo e por_canal agrupam as conversas; aguardando_resposta lista as 10 conversas em aberto que esperam resposta há mais tempo.

function buscar_pelo_filtro_dashboard(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroDashboard = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Dashboard>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_dashboard } from "termo_core/sell";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_dashboard(credencial_de_acesso, { dias: 1 });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Dashboard> · Rust: Result<tipos::Dashboard, ErroAoChamarServico> · veja Dashboard.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

Dashboard

import type { Dashboard } from "termo_core/sell";

export interface Dashboard {
  aguardando_resposta: Array<DashboardAguardando>;
  dias: number;
  gerado_em: string;
  indicadores: DashboardIndicadores;
  inicio: string;
  por_canal: Array<DashboardCanal>;
  por_dia: Array<DashboardDia>;
  por_hora: Array<DashboardHora>;
  por_robo: Array<DashboardRobo>;
  situacao_atual: Array<DashboardSituacao>;
}

DashboardAguardando

import type { DashboardAguardando } from "termo_core/sell";

export interface DashboardAguardando {
  aguardando_desde: string;
  cliente_razao_social?: string | null;
  contato_nome: string;
  contato_telefone: string;
  id: string;
  robo_nome?: string | null;
  status: string;
  ultima_mensagem: string;
}

DashboardCanal

import type { DashboardCanal } from "termo_core/sell";

export interface DashboardCanal {
  canal_id?: string | null;
  canal_nome: string;
  canal_tipo: string;
  conversas: number;
  mensagens_recebidas: number;
}

DashboardDia

import type { DashboardDia } from "termo_core/sell";

export interface DashboardDia {
  conversas_novas: number;
  dia: string;
  mensagens_da_equipe: number;
  mensagens_do_robo: number;
  mensagens_recebidas: number;
}

DashboardHora

import type { DashboardHora } from "termo_core/sell";

export interface DashboardHora {
  hora: number;
  mensagens_recebidas: number;
}

DashboardIndicadores

import type { DashboardIndicadores } from "termo_core/sell";

export interface DashboardIndicadores {
  aguardando_resposta: number;
  clientes_atendidos: number;
  conversas_atendidas: number;
  conversas_novas: number;
  conversas_novas_periodo_anterior: number;
  mensagens_da_equipe: number;
  mensagens_do_robo: number;
  mensagens_recebidas: number;
  passadas_para_equipe: number;
  primeira_resposta_da_equipe_segundos?: number | null;
  primeira_resposta_segundos?: number | null;
  resolvidas_pelo_robo: number;
  transferidas_sem_resposta: number;
}

DashboardRobo

import type { DashboardRobo } from "termo_core/sell";

export interface DashboardRobo {
  conversas: number;
  passadas_para_equipe: number;
  resolvidas_pelo_robo: number;
  robo_id?: string | null;
  robo_nome: string;
}

DashboardSituacao

import type { DashboardSituacao } from "termo_core/sell";

export interface DashboardSituacao {
  quantidade: number;
  status: string;
}

Nesta página