Use nossa API de análise do Live

A API de análise do Live oferece acesso programático aos dados e às métricas das conversas, tanto em tempo real quanto históricos.

 Com essa API, as equipes técnicas podem:

1. Integrar relatórios e análises de conversas em seus próprios sistemas.
2. Acessar o histórico de chats e métricas importantes, como tempos de resposta, resolução e cumprimento do SLA.
3. Analisar a produtividade dos agentes, o feedback dos clientes e as tendências ao longo do tempo.
4. Exportar dados em formato CSV para análise externa.
5. Criar relatórios personalizados e automatizar processos de monitoramento.

Importante: seu uso requer conhecimentos técnicos.

URL Base: https://live-public-api.agentbot.net

Você obterá as seguintes informações:

1. Get SLA: retorna as métricas SLA (Acordo de Nível de Serviço) das conversas agrupadas por equipe/grupo.
2. Get Export Simple List: exporta dados de conversas em formato CSV com informações detalhadas sobre cada conversa, incluindo tempos, participantes, resolução e feedback.
3. Get Conversation List: gera um histórico detalhado de todas as conversas que os agentes tiveram com os usuários, incluindo metadados da conversa, informações dos participantes e detalhes da sessão.
4. Get Stats: retorna métricas estatísticas e indicadores de desempenho para conversas dentro de um período de tempo especificado.
5. Get Feedback: resultados de pesquisas. Recebe a quantidade de comentários.
6. Get Histogram: retorna dados agregados de conversas, agrupados por intervalos de tempo, mostrando métricas como o total de conversas, as conversas encerradas, as perdidas, as transferências e o número de agentes ativos.
7. Get Summary: apresenta um resumo detalhado das métricas das conversas, agrupadas por período de tempo, grupo e protocolo, incluindo tempos de resposta, taxas de conclusão, feedback dos usuários e métricas de SLA.
8. Get Agents Stats: retorna métricas de desempenho e estatísticas detalhadas dos agentes, incluindo gerenciamento de conversas, tempos de resposta, pontuações de feedback e indicadores de produtividade.
9. Conversation List Detail: fornece os detalhes da conversa de acordo com o ID da conversa. A partir daí, você pode acessar todas as consultas inseridas pelo usuário durante a conversa, com as respostas correspondentes obtidas do Live.

Para utilizar a API, você precisa:

1. Acessar a documentação oficial.
2. Solicitar o token e o X-token do canal por meio de uma Solicitação de Serviço no Support Center.
3. Utilizar um usuárioque:
   1. Esteja registrado no bot correspondente à instância do Live a ser analisada.
   2. Tenha permissões habilitadas para a seção Relatórios.

Dados importantes:

1. Autenticação: especifique o método de autenticação utilizado: API Key, OAuth, Bearer Token, etc. Todas as solicitações à API devem incluir credenciais de autenticação válidas.
2. O token de autenticação tem validade de 10 horas. Recomenda-se incluir uma regra em seus serviços para renovação automática, quando possível. 
3. X-token: você deve usar o x-token do bot que você tem ativo. Todos os canais do bot compartilham o mesmo.
4. Sugere-se usar uma conta de e-mail corporativa para registrar as credenciais (por exemplo: nombre@corporativo.com).

Considerações técnicas:

1. Threads: nossas APIs suportam apenas 1 thread por consulta.
2. 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.
3. Limites de consulta: alguns endpoints têm restrições no intervalo de datas, dependendo da frequência selecionada.
   • Endpoint frequência Límite Máximo
     • Half-hour = máximo de 7 dias
     • Hour = máximo de 7 dias
     • Week = máximo de 1 mês
     • Month = máximo 1 mês.
4. Formato da resposta: todas as respostas da API são retornadas no formato JSON, exceto o endpoint de exportação, que retorna arquivos CSV.
   1. Content-Type: application/json (para a maioria dos endpoints)
   2. Content-Type: text/csv; charset=utf-8 (para endpoints de exportação)

Parâmetros comuns:

Parâmetros de data: a maioria dos endpoints requer parâmetros de intervalo de datas.

• from: Data e hora de início (formato: aaaa-MM-dd HH : mm : ss) Exemplo: from=2025-12-01 00:00:00

• até: data e hora de término (formato: aaaa-MM-dd HH : ss) Exemplo: até=2025-12-07 23:59:59

Parâmetros de frequência: alguns endpoints permitem agrupar dados por frequência temporal:

• HALF-HOUR: meia hora

• HOUR: hora

• DAY: dia

• WEEK: semana

• MONTH: mês

Parâmetros opcionais: consulte a documentação de cada endpoint para obter parâmetros opcionais específicos, como filtros por grupo, agente, protocolo, etc.

Endpoints disponíveis:

 Conversas

• GET /live/public/conversation/list - Lista detalhada de conversas

• GET /live/public/conversation/stats - Estatísticas agregadas de conversas

• GET /live/public/conversation/sla - Métricas de cumprimento de SLA

Análises e relatórios

• GET /live/public/histogram - Histograma de conversas por período

• GET /live/public/summary - Resumo detalhado com várias métricas

• GET /live/public/agent/performance - Relatório de desempenho dos agentes

Exportação

• GET /live/public/export-simple - Exportação de dados em formato CSV.

Códigos de estado HTTP:

Gerenciamento de erros: as respostas de erro incluem informações detalhadas sobre o problema:

Suporte a idiomas: alguns endpoints, como /export-simple, suportam vários idiomas para cabeçalhos e etiquetas: es - Espanhol / en - Inglês / pt - Português.