Capture des URL de relecture de session pour la journalisation externe

À propos de la capture des URL de relecture de session pour la journalisation externe

Outre les rediffusions des sessions de visualisation au sein de la plateforme Qualtrics, vous pouvez également choisir de relier certaines sessions utilisateur directement à vos systèmes de journalisation (tels que Splunk ou Datadog), à des outils de suivi des erreurs (tels que New Relic) ou à des tickets d'assistance client.

En exploitant une simple API Qualtrics, vous pouvez récupérer par programmation l'URL unique de relecture de la session en cours d'un visiteur et la transmettre à votre équipe technique afin de faciliter le débogage et le dépannage. Cela permet notamment de prendre en charge des cas d'utilisation courants tels que : 

• Débogage des erreurs intermittentes du site: transmettez l'URL à des outils tels que Splunk, LogRocket ou New Relic afin de mettre en corrélation les journaux côté serveur avec le comportement visuel côté client.
• Service client: intégrez automatiquement le lien vers l'enregistrement dans les tickets générés via des CRM tels que Zendesk et Salesforce.

Attention: Les fonctions de codage personnalisé sont fournies en l'état et leur mise en œuvre nécessite des connaissances en programmation. Le support de Qualtrics ne propose pas d'assistance ou de consultation sur le codage personnalisé. Vous pouvez toujours essayer de poser votre question à notre communauté d'utilisateurs passionnés. Si vous souhaitez en savoir plus sur nos services de développement sur mesure, veuillez contacter votre commercial Qualtrics.

Conditions préalables

Avant d'utiliser cette API, assurez-vous des points suivants :

• L'analyse de l’expérience numérique est activée pour votre organisation.
• La fonctionnalité de relecture de session est activée dans votre projet digital.
•  Le code JavaScript du projet Qualtrics est correctement déployé sur votre site web.
• Votre équipe d'ingénieurs dispose d'un compte utilisateur Qualtrics doté de l'autorisation « Accès à l'API » et de l'autorisation de partage « Session » au sein de votre projet numérique.

Mise en œuvre de l'API

Pour plus de détails techniques, veuillez consulter notre documentation sur l'API.

Pour récupérer l'URL et l'envoyer à un outil externe, vous devez encadrer l'appel d'une vérification permettant de vous assurer que les modules JavaScript de Qualtrics (QSI) et Session Replay (SR) ont bien été chargés.

Exemple : enregistrement dans un outil de suivi des erreurs

Si votre site rencontre une erreur JavaScript, vous pouvez joindre l'URL de la rediffusion de session au rapport d'erreur afin que vos ingénieurs puissent voir exactement ce que l'utilisateur a fait avant le plantage.

window.addEventListener('error', function() {
  if (window.QSI && QSI.API) {
    const replayUrl = QSI.API.SessionRecording.getSessionSync().playbackUrl;
   
    // Exemple : envoi vers un outil tel que Sentry ou un enregistreur de journaux personnalisé
    console.log("Erreur détectée.") Regardez ici la rediffusion de la session : " + replayUrl);
   // myLoggingTool.captureMessage("Erreur utilisateur", { extra: { sessionUrl: replayUrl } });
  }
});

Exemple : enregistrement de l'URL dans un formulaire d'assistance

Si un utilisateur envoie un formulaire « Nous contacter » ou « Signaler un bug » depuis votre site, vous pouvez intégrer l'URL de lecture dans un champ masqué afin de fournir immédiatement le contexte nécessaire à l'agent du service d'assistance. Notez que si vous utilisez un questionnaire Qualtrics pour votre formulaire d'assistance, celui-ci récupérera automatiquement l'URL de lecture.

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 || "Aucune rediffusion disponible" ;
    }
});

Exemple : transmission des informations de session à votre couche de données

Si vous utilisez une plateforme d'analyse tierce, vous pouvez envoyer l'identifiant de session et les URL de relecture à ce système afin de pouvoir facilement établir des corrélations entre les relectures de sessions Qualtrics sur différentes plateformes.

    
       
      
      
    
  // Attendre le chargement de Qualtrics
window.addEventListener('qsi_js_loaded', async function() {
  try {
    // Attendre l'initialisation de la session et récupérer les informations de session
    const session = await window.QSI.API.SessionRecording.getSession();
   
    // Initialiser dataLayer s'il n'existe pas
    window.dataLayer = window.dataLayer || [];
   
     XML } catch (error) {
    console.error('Échec de la récupération des informations de session DXA :', error);
  }
});

Considérations importantes

Moment

L'API ` QSI.API.SessionRecording.getSessionSync()` renverra l'  « null » si elle est appelée dès le chargement de la page, avant que la session n'ait eu le temps de démarrer. Il est recommandé d'appeler cette API au sein d'un écouteur d'évènement (comme le clic sur un bouton ou le déclencheur d'une erreur).

La méthode QSI.API.SessionRecording.getSession() se charge d'attendre le démarrage de la session, mais gardez à l'esprit qu'elle peut ne jamais aboutir. Par exemple, si votre projet est configuré pour attendre que votre page appelle l'API « start » une fois que l'utilisateur a donné son consentement, et que celui-ci ne donne jamais son consentement, la fonction getSession() ne s'exécutera jamais jusqu'au bout.

Confidentialité et autorisations

• Contrôle d'accès: seuls les utilisateurs Qualtrics disposant de l'autorisation « Sessions » dans le projet numérique pourront accéder à la session via l'URL. Si un utilisateur non autorisé clique sur le lien, il sera invité à se connecter à son compte Qualtrics, et la session ne s'affichera que si son compte dispose des droits d'accès nécessaires.
• Masquage: la lecture accessible via cette URL continuera de respecter toutes les règles de masquage des données (protection des données à caractère personnel) configurées dans les paramètres de votre projet.
• Échantillonnage: si un utilisateur est exclu d'un enregistrement en raison du taux d'échantillonnage de votre projet, l'API ne renverra pas d'URL.

Résolution des problèmes

Cette section traite des problèmes les plus courants et de leurs causes :