Erfassen von URLs zur Sitzungswiedergabe für die externe Protokollierung

Informationen zum Erfassen von Urls für die Wiedergabe von Sitzungen zur externen Protokollierung

Neben den Aufzeichnungen von Betrachtungssitzungen innerhalb der Qualtrics-Plattform möchten Sie möglicherweise bestimmte Benutzersitzungen direkt mit Ihren Protokollierungssystemen (wie Splunk oder Datadog), Fehlerverfolgungs-Tools (wie New Relic) oder Kundensupport-Tickets verknüpfen.

Mithilfe einer einfachen Qualtrics-API können Sie die eindeutige URL zur Wiedergabe der aktuellen Sitzung eines Besuchers programmgesteuert abrufen und an Ihr Entwicklerteam weiterleiten, um die Fehlersuche und Fehlerbehebung zu optimieren. Dies ermöglicht unter anderem folgende typische Anwendungsfälle: 

• Behebung sporadisch auftretender Website-Fehler: Leiten Sie die URL an Tools wie Splunk, LogRocket oder New Relic weiter, um serverseitige Protokolle mit dem visuell beobachtbaren Verhalten auf der Client-Seite abzugleichen.
• Kundensupport: Fügen Sie den Link zur Aufzeichnung automatisch in Tickets ein, die über CRM-Systeme wie Zendesk und Salesforce erstellt werden.

Achtung: Funktionen für benutzerdefiniertes Coding werden unverändert bereitgestellt und erfordern Programmierkenntnisse zur Implementierung. Der Qualtrics Support bietet keinerlei Hilfestellung oder Beratung im Zusammenhang mit eigenem Programmcode an. Sie können es stattdessen jederzeit bei unserer Community engagierter Nutzer versuchen. Wenn Sie mehr über unsere maßgeschneiderten Programmierdienstleistungen erfahren möchten, wenden Sie sich bitte an Ihren Qualtrics-Account Executive.

Voraussetzungen

Bevor Sie diese API nutzen, stellen Sie bitte Folgendes sicher:

• Die Funktion „Digital Experience Analytics “ ist für Ihre Organisation aktiviert.
• Die Sitzungswiedergabe ist in Ihrem digitalen Projekt aktiviert.
•  Der JavaScript-Code des Qualtrics-Projekts wurde korrekt auf Ihrer Website implementiert.
• Ihr Entwicklerteam hat Zugriff auf ein Qualtrics-Benutzerkonto mit der Benutzerberechtigung „Auf API zugreifen“ und der Freigabeberechtigung „Sitzung“ innerhalb Ihres digitalen Projekts.

Implementierung der API

Technische Details finden Sie in unserer API-Dokumentation.

Um die URL zu erfassen und an ein externes Tool zu senden, sollten Sie den Aufruf in eine Überprüfung einbetten, um sicherzustellen, dass das Qualtrics-JavaScript (QSI) und die Session-Replay-Module (SR) geladen wurden.

Beispiel: Protokollierung in einem Fehlerverfolgungstool

Sollte auf Ihrer Website ein JavaScript-Fehler auftreten, können Sie die URL der Sitzungswiedergabe dem Fehlerbericht beifügen, damit Ihre Techniker genau nachvollziehen können, welche Schritte der Benutzer bis zum Absturz unternommen hat.

window.addEventListener('error', function() {
  if (window.QSI && QSI.API) {
    const replayUrl = QSI.API.SessionRecording.getSessionSync().playbackUrl;
   
    // Beispiel: Senden an ein Tool wie Sentry oder einen benutzerdefinierten Logger
    console.log("Fehler erkannt."); Hier die Aufzeichnung der Sitzung ansehen: " + replayUrl);
   // myLoggingTool.captureMessage("Benutzerfehler", { extra: { sessionUrl: replayUrl } });
  }
});

Beispiel: Speichern der URL in einem Support-Formular

Wenn ein Nutzer auf Ihrer Website ein Formular unter „Kontakt“ oder „Fehler melden“ absendet, können Sie die Wiedergabe-URL in einem versteckten Feld hinterlegen, um dem Supportmitarbeiter sofort den Kontext zu liefern. Bitte beachten Sie: Wenn Sie für Ihr Support-Formular eine Qualtrics-Umfrage verwenden, wird die Wiedergabe-URL automatisch erfasst.

         const form = document.querySelector('#support-form');
form.addEventListener('submit', function() {
    if 
        document.querySelector('#hidden-replay-input').value = replayUrl || "Keine Wiedergabe verfügbar";
    }
});

Beispiel: Übermittlung der Sitzungsinformationen an Ihre Datenschicht

Wenn Sie eine Analyseplattform eines Drittanbieters verwenden, empfiehlt es sich, die Sitzungs-ID und die Wiedergabe-URLs an dieses System zu übermitteln, damit Sie Qualtrics-Sitzungswiedergaben plattformübergreifend problemlos miteinander verknüpfen können.

// Warten, bis Qualtrics geladen ist
window.addEventListener('qsi_js_loaded', async function() {
  try {
    // Warten, bis die Sitzung initialisiert ist, und Sitzungsinformationen abrufen
    const session = await window.QSI.API.SessionRecording.getSession();
   
    // dataLayer initialisieren, falls er nicht vorhanden ist
    window.dataLayer = window.dataLayer || [];
   
    // Sitzungsinformationen an das Google dataLayer senden
    window.dataLayer.push({
      'event': 'dxa_session_started',
      'dxa_session_id': session.sessionId,
      'dxa_playback_url': session.playbackUrl
    });
  } catch (error) {
    console.error('Abruf der DXA-Sitzungsinformationen fehlgeschlagen:', error);
  }
});

Wichtige Überlegungen

Zeiten

Die API-Methode „QSI.API.SessionRecording.getSessionSync()“ gibt den Wert „  “ „null“ zurück, wenn sie unmittelbar nach dem Laden der Seite aufgerufen wird, bevor die Sitzung überhaupt beginnen kann. Es empfiehlt sich, diese API innerhalb eines Ereignis-Listeners aufzurufen (z. B. beim Klicken auf eine Schaltfläche oder bei einem Fehler).

QSI.API.SessionRecording.getSession() übernimmt das Warten auf den Start der Sitzung, aber beachten Sie, dass dieser Vorgang möglicherweise nie abgeschlossen wird. Wenn Ihr Projekt beispielsweise so konfiguriert ist, dass es darauf wartet, dass Ihre Seite die Start-API aufruft, sobald der Nutzer seine Einwilligung erteilt hat, und der Nutzer diese Einwilligung jedoch nie erteilt, wird getSession() niemals abgeschlossen.

Datenschutz und Berechtigungen

• Zugriffskontrolle: Nur Qualtrics-Benutzer mit der Berechtigung „Sessions“ im digitalen Projekt können die Sitzung über die URL aufrufen. Wenn ein nicht autorisierter Benutzer auf den Link klickt, wird er aufgefordert, sich bei seinem Qualtrics-Benutzerkonto anzumelden, und die Sitzung wird ihm nur angezeigt, wenn sein Benutzerkonto über die entsprechenden Zugriffsrechte verfügt.
• Maskierung: Bei der Wiedergabe über diese URL werden weiterhin alle in Ihren Projekteinstellungen konfigurierten Regeln zur Datenmaskierung (Schutz personenbezogener Daten) beachtet.
• Abtastrate: Wenn ein Nutzer aufgrund der Abtastrate Ihres Projekts für eine Aufnahme nicht berücksichtigt wird, gibt die API keine URL zurück.

Fehlerbehebung

In diesem Abschnitt werden häufig auftretende Probleme und deren Ursachen behandelt: