SDK-Konfiguration – Referenz - Scanova API Documentation

Das SDK wird mit einem einzigen Aufruf scanova('init', siteId, options) konfiguriert. Diese Seite dokumentiert jede verfügbare Option.

Syntax

scanova('init', 'YOUR_SITE_ID', {
  // options here
});

Übersicht der Optionen

Option	Typ	Standard	Beschreibung
`autoPageview`	boolean	`false`	Sendet bei jedem Seitenaufruf automatisch ein `pageview`-Ereignis.
`autoClicks`	boolean	`false`	Erfasst automatisch Klicks auf Links, Schaltflächen und `[role="button"]`-Elemente.
`autoForms`	boolean	`false`	Erfasst automatisch Formularabsendungen.
`autoScroll`	boolean	`false`	Erfasst die Scrolltiefe bei den Marken 25 %, 50 %, 75 % und 90 %.
`debug`	boolean	`false`	Gibt die SDK-Aktivität in der Browser-Konsole aus. Nützlich während der Entwicklung.
`endpoint`	string	`https://t.scanova.io/ct`	Überschreibt den Endpunkt für die Ereigniserfassung. Ändern Sie ihn nur auf Anweisung des Scanova-Supports.

Die Optionen im Detail

`autoPageview`

Löst bei jeder Initialisierung des SDK auf einer Seite ein pageview-Ereignis aus. Bei vollständigen Seitenaufrufen geschieht das automatisch. Für Single-Page-Apps beschreibt der SPA-Leitfaden, wie Sie Seitenaufruf-Ereignisse bei Routenwechseln auslösen.

scanova('init', 'YOUR_SITE_ID', { autoPageview: true });

Jedes pageview-Ereignis enthält page_url, referrer, scan_session_id sowie Geräte- und Besucherkontext. Das vollständige Payload finden Sie unter Automatisch erfasste Ereignisse.

`autoClicks`

Lauscht auf Klicks auf:

<a>-Tags
<button>-Tags
Elemente mit role="button"

Das erfasste Klick-Ereignis enthält element_type, element_text und bei Links optional destination_url. Tipp: Fügen Sie einem beliebigen Element data-scnv-name="My Button" hinzu, um die erfasste Bezeichnung zu überschreiben:

<button data-scnv-name="Pricing CTA">Start Trial</button>

`autoForms`

Lauscht auf das submit-Ereignis von <form>-Elementen. Erfasst form_name und form_action. Die Feldwerte des Formulars werden nie erfasst — nur die Kennung des Formulars. Tipp: Geben Sie einem Formular mit data-scnv-name="Contact Form" einen lesbaren Namen für Berichte.

`autoScroll`

Löst Scrolltiefe-Ereignisse aus, wenn die Person 25 %, 50 %, 75 % und 90 % der Seitenhöhe überscrollt. Jede Marke wird nur einmal pro Seitenaufruf ausgelöst und enthält scroll_depth in den Metadaten.

`debug`

Aktiviert die Protokollierung in der Konsole. Nutzen Sie sie während der Entwicklung, um zu prüfen, ob sich das SDK initialisiert, Ereignisse erfasst und korrekt sendet.

scanova('init', 'YOUR_SITE_ID', { debug: true });
// Console output:
// [QCG SDK] Initialized with Site ID: YOUR_SITE_ID
// [QCG SDK] Loaded version 1.x.x

Deaktivieren Sie debug im Produktivbetrieb — die Option ist standardmäßig false.

Empfohlene Konfiguration für den Produktivbetrieb

scanova('init', 'YOUR_SITE_ID', {
  autoPageview: true,
  autoClicks: true,
  autoForms: true,
  autoScroll: true,
  debug: false
});

Minimale Konfiguration (nur Seitenaufrufe)

scanova('init', 'YOUR_SITE_ID', {
  autoPageview: true
});

Nur manuell (kein Auto-Tracking)

Verwenden Sie dies, wenn Sie volle Kontrolle darüber wollen, was erfasst wird — jedes Ereignis senden Sie dann ausdrücklich über scanova('track', ...).

scanova('init', 'YOUR_SITE_ID', {
  autoPageview: false,
  autoClicks: false,
  autoForms: false,
  autoScroll: false
});

Wichtig: ein init pro Seitenaufruf

Rufen Sie scanova('init', ...) einmal pro Seitenlebenszyklus auf. Mehrfache Aufrufe registrieren doppelte Auto-Tracking-Listener und führen zu doppelten Ereignissen. Rufen Sie init in Single-Page-Apps einmal beim Start der Anwendung auf — nicht bei jedem Routenwechsel. Für das Tracking bei Routenwechseln nutzen Sie den SPA-Leitfaden.

Tracking für bestimmte Personen deaktivieren

Das SDK hat keine eingebaute disable()-Methode. Um das Tracking für bestimmte Personen zu verhindern (angemeldete Mitarbeitende, Personen mit Widerspruch, Bots), laden Sie das Snippet bedingt gar nicht erst:

<script>
  // Example: skip tracking for your own team
  const isInternalUser = document.cookie.includes('internal_user=true');

  if (!isInternalUser) {
    (function(w,d,s,o,f,js,fjs){
      w['ScanovaTrackingObject']=o;w[o]=w[o]||function(){(w[o].q=w[o].q||[]).push(arguments)};
      js=d.createElement(s),fjs=d.getElementsByTagName(s)[0];
      js.id=o;js.src=f;js.async=1;fjs.parentNode.insertBefore(js,fjs);
    })(window,document,'script','scanova','https://cdn.scanova.io/ct/js/qcg.min.js');
    scanova('init', 'YOUR_SITE_ID', { autoPageview: true });
  }
</script>

Dasselbe Muster gilt für die DSGVO-Einwilligung — laden Sie das SDK erst, nachdem die Einwilligung zum Tracking erteilt wurde. Details unter Datenschutz und DSGVO.

Überblick

Browser-SDK

Serverseitig

API-Referenz

Ressourcen

SDK-Konfiguration – Referenz

Syntax

Übersicht der Optionen

Die Optionen im Detail

`autoPageview`

`autoClicks`

`autoForms`

`autoScroll`

`debug`

Empfohlene Konfiguration für den Produktivbetrieb

Minimale Konfiguration (nur Seitenaufrufe)

Nur manuell (kein Auto-Tracking)

Wichtig: ein init pro Seitenaufruf

Tracking für bestimmte Personen deaktivieren

​Syntax

​Übersicht der Optionen

​Die Optionen im Detail

​autoPageview

​autoClicks

​autoForms

​autoScroll

​debug

​Empfohlene Konfiguration für den Produktivbetrieb

​Minimale Konfiguration (nur Seitenaufrufe)

​Nur manuell (kein Auto-Tracking)

​Wichtig: ein init pro Seitenaufruf

​Tracking für bestimmte Personen deaktivieren

Syntax

Übersicht der Optionen

Die Optionen im Detail

`autoPageview`

`autoClicks`

`autoForms`

`autoScroll`

`debug`

Empfohlene Konfiguration für den Produktivbetrieb

Minimale Konfiguration (nur Seitenaufrufe)

Nur manuell (kein Auto-Tracking)

Wichtig: ein init pro Seitenaufruf

Tracking für bestimmte Personen deaktivieren