Acquisizione degli URL di riproduzione delle sessioni per la registrazione esterna

Informazioni sull'acquisizione degli URL di riproduzione delle sessioni per la registrazione esterna

Oltre alle registrazioni delle sessioni di visualizzazione disponibili sulla piattaforma Qualtrics, potresti voler collegare sessioni utente specifiche direttamente ai tuoi sistemi di registrazione (come Splunk o Datadog), agli strumenti di monitoraggio degli errori (come New Relic) o ai ticket dell’assistenza clienti.

Sfruttando una semplice API di Qualtrics, è possibile recuperare in modo programmatico l'URL univoco di riproduzione della sessione corrente di un visitatore e trasmetterlo al proprio team di ingegneri per semplificare il debug e la risoluzione dei problemi. Ciò contribuisce a rendere possibili casi d'uso comuni quali: 

• Risoluzione degli errori intermittenti del sito: invia l'URL a strumenti come Splunk, LogRocket o New Relic per correlare i log lato server con il comportamento visivo lato client.
• Assistenza clienti: includi automaticamente il link alla registrazione nei ticket generati tramite CRM come Zendesk e Salesforce.

Attenzione: Le funzioni di codifica personalizzate sono fornite così come sono e richiedono conoscenze di programmazione per essere implementate. Il Supporto Qualtrics non offre assistenza o consulenza riguardo alla programmazione personalizzata. In alternativa, puoi sempre provare a chiedere alla nostra comunità di utenti affezionati. Se desiderate saperne di più sui nostri servizi di programmazione personalizzata, contattate il vostro Account Executive di Qualtrics.

Prerequisiti

Prima di utilizzare questa API, assicurati che:

• L'analisi dell'esperienza digitale è abilitata per la tua organizzazione.
• La riproduzione della sessione è attiva nel tuo progetto digitale.
•  Il codice JavaScript del progetto Qualtrics è stato correttamente implementato sul tuo sito web.
• Il tuo team di ingegneri ha accesso a un account utente Qualtrics con l'autorizzazione "Access API " e l'autorizzazione di condivisione "Session" all'interno del tuo progetto digitale.

Implementazione dell'API

Per i dettagli tecnici, consulta la nostra documentazione sull'API.

Per acquisire l'URL e inviarlo a uno strumento esterno, è necessario racchiudere la chiamata in un controllo che verifichi che i moduli Qualtrics JavaScript (QSI) e Session Replay (SR) siano stati caricati.

Esempio: registrazione in uno strumento di monitoraggio degli errori

Se il tuo sito rileva un errore JavaScript, puoi allegare l'URL della riproduzione della sessione al rapporto sull'errore, in modo che i tuoi tecnici possano vedere esattamente quali azioni ha compiuto l'utente prima del crash.

window.addEventListener('error', function() {
  if (window.QSI && QSI.API) {
    const replayUrl = QSI.API.SessionRecording.getSessionSync().playbackUrl;
   
    // Esempio: invio a uno strumento come Sentry o a un logger personalizzato
    console.log("Errore rilevato."); Guarda qui la registrazione della sessione: " + replayUrl);
   // myLoggingTool.captureMessage("Errore utente", { extra: { sessionUrl: replayUrl } });
  }
});

Esempio: come memorizzare l'URL in un modulo di assistenza

Se un utente invia un modulo “Contattaci” o “Segnala un bug” dal tuo sito, puoi inserire l’URL di riproduzione in un campo nascosto per fornire all’addetto all’assistenza un contesto immediato. Tieni presente che, se utilizzi un sondaggio Qualtrics come modulo di assistenza, l'URL di riproduzione verrà acquisito automaticamente.

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 || "Nessun replay disponibile";
    }
});

Esempio: invio delle informazioni sulla sessione al livello dati

Se utilizzi una piattaforma di analisi di terze parti, potresti voler inviare l’ID della sessione e gli URL di riproduzione a tale sistema, in modo da poter correlare facilmente le riproduzioni delle sessioni di Qualtrics tra le diverse piattaforme.

// Attendere il caricamento di Qualtrics
window.addEventListener('qsi_js_loaded', async function() {
  try {
    // Attendere l'inizializzazione della sessione e recuperare le informazioni relative alla sessione
    const session = await window.QSI.API.SessionRecording.getSession();
   
    // Inizializza dataLayer se non esiste
    window.dataLayer = window.dataLayer || [];
   
    // Invia le informazioni sulla sessione al dataLayer di Google
    window.dataLayer.push({
      'event': 'dxa_session_started',
      'dxa_session_id': session.sessionId,
      'dxa_playback_url': session.playbackUrl
    });
  } catch (error) {
    console.error('Impossibile recuperare le informazioni sulla sessione DXA:', error);
  }
});

Considerazioni importanti

Temporizzazione

L'API QSI.API.SessionRecording.getSessionSync() restituirà "null" nell'  se viene chiamata immediatamente dopo il caricamento della pagina, prima che la sessione abbia avuto modo di avviarsi. Si consiglia di chiamare questa API all'interno di un listener di evento (ad esempio, al clic su un pulsante o in caso di errore).

Il metodo QSI.API.SessionRecording.getSession() si occupa di attendere l'avvio della sessione, ma occorre tenere presente che l'operazione potrebbe non andare mai a buon fine. Ad esempio, se il tuo progetto è configurato in modo tale da attendere che la pagina chiami l'API di avvio una volta che l'utente ha fornito il consenso, e l'utente non fornisce mai effettivamente il consenso, getSession() non verrà mai completata.

Privacy e autorizzazioni

• Controllo degli accessi: solo gli utenti Qualtrics in possesso dell’autorizzazione “Sessioni” nel progetto digitale potranno visualizzare la sessione tramite l’URL. Se un utente non autorizzato clicca sul link, gli verrà richiesto di effettuare l'accesso al proprio account Qualtrics e gli verrà mostrata la sessione solo se il suo account dispone dei diritti di accesso necessari.
• Mascheramento: la riproduzione visualizzata tramite questo URL continuerà a rispettare tutte le regole di mascheramento dei dati (protezione delle informazioni di identificazione personale) configurate nelle impostazioni del progetto.
• Campionamento: se un utente viene escluso da una registrazione in base alla frequenza di campionamento del progetto, l'API non restituirà alcun URL.

Risoluzione dei problemi

Questa sezione tratta i problemi più comuni e le loro cause: