A API de análise do Live permite acessar informações detalhadas sobre agentes, sessões e métricas operacionais para gerar relatórios personalizados, automatizar análises ou integrar-se a outras ferramentas de monitoramento.
Importante: seu uso requer conhecimentos técnicos.
Para usar a API, você precisa:
- Acessar a documentação oficial.
- Solicitar o token e o X-token do canal por meio de uma Solicitação de Serviço no Support Center.
- Esteja registrado no bot correspondente.
- Tenha permissões habilitadas para a seção Análise.
Dados importantes:
- O token de autenticação tem validade de 10 horas. Recomenda-se incluir, quando possível, uma regra de renovação automática em seus serviços.
- Sugere-se usar uma conta de e-mail corporativa para registrar as credenciais (ex.: nome@corporativo.com).
Considerações técnicas
- Intervalo recomendado para filtrar dados: 7 dias. É possível definir qualquer intervalo de tempo necessário. No entanto, o tempo de resposta da API dependerá do volume de dados envolvido: quanto maior a quantidade de informações, maior será o tempo de processamento.
- X-token: você deve usar o xtoken do bot que está ativo. Todos os canais do bot compartilham o mesmo.
- Threads: nossas APIs suportam apenas 1 thread por consulta.
- Disponibilidade: as informações não estão disponíveis em tempo real. Esta API é voltada para consultas e relatórios, não para automações em tempo real.
Obterá as seguintes informações:
- GetConversationList: lista de conversas filtradas por data.
- GetConversationDetail: detalhes de uma conversa específica.
- GetSLA: nível de cumprimento do SLA por grupo.
- GetFeedback: resultados de pesquisas.
- GetStats: status das conversas. Exemplo: total de atendidas, transferidas, etc.
- GetAgentsStats: dados do relatório dos agentes para o período determinado.
- GetAgent: informações individuais de um agente (por exemplo: nome, número de chamadas simultâneas).
- GetGroup: dados sobre grupos (nome, tipo de atribuição).