Captura de URLs de reprodução de sessão para registro externo

Sobre a captura de URLs de reprodução de sessão para registro externo

Além das reproduções das sessões de visualização na plataforma Qualtrics, talvez você queira vincular sessões específicas de usuários diretamente aos seus sistemas de registro (como Splunk ou Datadog), ferramentas de rastreamento de erros (como New Relic) ou tíquetes de suporte ao cliente.

Ao utilizar uma API simples Qualtrics, você pode recuperar programaticamente a URL exclusiva de reprodução da sessão atual de um visitante e repassá-la à sua equipe de engenharia para agilizar a depuração e a solução de problemas. Isso ajuda a viabilizar casos de uso comuns, como: 

• Depuração de erros intermitentes no site: envie a URL para ferramentas como Splunk, LogRocket ou New Relic para correlacionar os logs do lado do servidor com o comportamento visual do lado do cliente.
• Suporte ao cliente: inclua automaticamente o link de reprodução nos tíquetes gerados por meio de CRMs como o Zendesk e o Salesforce.

Atenção: Os recursos de codificação personalizada são fornecidos no estado em que se encontram e exigem conhecimento de programação para serem implementados. O suporte da Qualtrics não oferece assistência nem consultoria em codificação customizada. Você sempre pode tentar perguntar à nossa comunidade de usuários dedicados. Caso deseje saber mais sobre nossos serviços de programação personalizada, entre em contato com seu  executivo de contas Qualtrics.

Pré-requisitos

Antes de usar esta API, certifique-se do seguinte:

• Análise da experiência digital está habilitada para a sua organização.
• A reprodução da sessão está ativada no seu projeto digital.
•   O código JavaScript do projeto Qualtrics está corretamente implementado no seu site.
• Sua equipe de engenharia tem acesso a uma conta de usuário Qualtrics com a permissão de usuário “Acesso à API” e a permissão de compartilhamento “Sessão” dentro do seu projeto digital.

Implementação da API

Consulte nossa documentação da API para obter detalhes técnicos.

Para capturar a URL e enviá-la a uma ferramenta externa, você deve incluir na chamada uma verificação para garantir que os módulos Qualtrics JavaScript (QSI) e Session Replay (SR) tenham sido carregados.

Exemplo: Registro em uma ferramenta de rastreamento de erros

Se o seu site apresentar um erro de JavaScript, você pode anexar a URL da reprodução da sessão ao relatório de erro para que seus engenheiros possam ver exatamente o que o usuário fez antes da falha.

window.addEventListener('error', function() {
  if (window.QSI && QSI.API) {
    const replayUrl = QSI.API.SessionRecording.getSessionSync().playbackUrl;
   
    // Exemplo: Envio para uma ferramenta como o Sentry ou um registrador de logs personalizado
    console.log("Erro detectado."); Veja a reprodução da sessão aqui: " + replayUrl);
   // myLoggingTool.captureMessage("Erro do usuário", { extra: { sessionUrl: replayUrl } });
  }
});

Exemplo: Como salvar a URL em um formulário de suporte

Se um usuário enviar um formulário de “Fale conosco” ou “Relato de bug” no seu site, você pode incluir a URL de reprodução em um campo oculto para fornecer contexto imediato ao agente de suporte. Observe que, se você estiver usando uma pesquisa Qualtrics como seu formulário de suporte, ela capturará automaticamente a URL de reprodução.

const form = document.querySelector('#support-form');
form.addEventListener('submit', function() {
    if (window.QSI && QSI.API.SessionRecording.getSessionSync()) {
        const replayUrl = QSI.API.SessionRecording.getSessionSync().playbackUrl;
       document.querySelector('#hidden-replay-input').value = replayUrl || "Nenhuma reprodução disponível";
    }
});

Exemplo: Envio das informações da sessão para a camada de dados

Se você estiver usando uma plataforma de análise de terceiros, talvez seja interessante enviar o ID da sessão e as URLs de reprodução para esse sistema, a fim de facilitar a correlação das reproduções de sessões Qualtrics entre plataformas.

// Aguardar o carregamento Qualtrics
window.addEventListener('qsi_js_loaded', async function() {
  try {
    // Aguardar a inicialização da sessão e obter as informações da sessão
    const session = await window.QSI.API.SessionRecording.getSession();
   
    // Inicializar o dataLayer caso ele não exista
    window.dataLayer = window.dataLayer || [];
   
    // Enviar informações da sessão para o dataLayer do Google
    window.dataLayer.push({
      'event': 'dxa_session_started',
      'dxa_session_id': session.sessionId,
      'dxa_playback_url': session.playbackUrl
    });
  } catch (error) {
    console.error('Falha ao obter as informações da sessão DXA:', error);
  }
});

Considerações Importantes

Temporizador

A API QSI.API.SessionRecording.getSessionSync() retornará um valor “null” d , se for chamada imediatamente após o carregamento da página, antes que a sessão tenha tempo de iniciar. É recomendável chamar essa API dentro de um ouvinte de evento (como o clique em um botão ou um gatilho de erro).

O método QSI.API.SessionRecording.getSession() é responsável por aguardar o início da sessão, mas lembre-se de que ele pode nunca ser concluído. Por exemplo, se o seu projeto estiver configurado para aguardar que a sua página chame a API de início assim que o usuário der o consentimento, e o usuário nunca der esse consentimento, a função getSession() nunca será concluída.

Privacidade e permissões

• Controle de acesso: Somente usuários Qualtrics com a permissão “Sessões” no projeto digital poderão visualizar a sessão por meio da URL. Se um usuário não autorizado clicar no link, será solicitado que ele faça login em sua conta Qualtrics, e a sessão só será exibida se a conta dele tiver os direitos de acesso adequados.
• Ocultação de dados: A reprodução acessada por meio desta URL continuará respeitando todas as regras de ocultação de dados (proteção de informações de identificação pessoal) configuradas nas definições do seu projeto.
• Amostragem: Se um usuário for excluído de uma gravação com base na taxa de amostragem do seu projeto, a API não retornará uma URL.

Solução de problemas

Esta seção aborda os problemas mais comuns e suas causas: