Dokumentation

Attribute am Skript-Tag

Ein Skript-Tag mit einigen gesetzten Attributen:

<script
  src="https://api.privatrak.com/tracker.js"
  data-api-key="your-website-key"
  data-autocapture="pageviews,clicks"
  data-excluded-urls="/admin/*"
  defer
></script>

Alle Attribute sind optional außer data-api-key. Lassen Sie eines weg, gilt auf der Seite der Wert aus den Tracker-Einstellungen Ihres Projekts. Diese beginnen mit den Standardwerten unten. Setzen Sie ein Attribut, hat es auf den Seiten Vorrang, die es tragen.

Funktionen

Das Skript-Tag stellt diese Funktionen unter window.tracker bereit. Das npm-Paket exportiert sie.

interface TrackerInitConfig {
  apiKey?: string;
  apiHost?: string;
  flushIntervalMs?: number;
  maxQueueSize?: number;
  walkDepth?: number;
  maxTextLength?: number;
  autocapturePageviews?: boolean;
  autocapture?: boolean;
  autocaptureElements?: string[];
  piiUrlParams?: string[];
  normalizePathIds?: boolean;
  piiValuePatterns?: string[];
  excludedUrls?: string[];
  traits?: string[];
}

Den Tracker selbst starten

Fügen Sie dem Skript-Tag data-manual-init hinzu, wenn der Tracker warten soll, etwa bis die Einwilligungsentscheidung eines Besuchers vorliegt oder Ihre Seite den Schlüssel aus Ihrer eigenen Konfiguration gelesen hat. Bis Sie window.tracker.init() aufrufen, wird nichts erfasst. Dann erfasst der Tracker einen Seitenaufruf für die Seite, auf der der Besucher gerade ist.

<script src="https://api.privatrak.com/tracker.js" data-manual-init defer></script>
<script>
  // Later, once your page is ready:
  window.tracker.init({
    apiKey: "your-website-key",
    apiHost: "https://api.privatrak.com"
  });
</script>

Bevor der Tracker gestartet ist, erfasst er nichts, auch keine Aufrufe von track(). Mit defer startet das Skript-Tag, sobald es geladen ist. Ohne defer startet es, wenn die Seite fertig geladen ist. Beim npm-Paket oder mit data-manual-init startet es, wenn init() läuft.

Wenn nichts gesendet wird

Kommen keine Events an, öffnen Sie auf Ihrer Website die Konsole des Browsers. Stimmt etwas nicht, schreibt der Tracker dort eine Zeile, die mit [tracker] beginnt:

• Missing apiKey. Events will not be sent. Der Schlüssel fehlt. Fügen Sie dem Skript-Tag data-api-key hinzu oder übergeben Sie apiKey an init(). Rufen Sie init() nur einmal auf, mit dem Schlüssel. Spätere Aufrufe werden ignoriert.
• Could not load this project's settings … Der Tracker hat es mehrmals versucht und sendet bei diesem Seitenaufruf nichts. Die Zeile nennt den Grund. Prüfen Sie den Schlüssel und Ihre Verbindung und laden Sie die Seite neu.
• The API rejected events with HTTP 401 … Der Schlüssel ist ungültig. Nehmen Sie Ihren Website-Schlüssel aus Einstellungen › API-Schlüssel.
• The API rejected events with HTTP 403 … Diese Website gehört nicht zu den erlaubten Domains Ihres Projekts. Tragen Sie sie dort ein.
• The API rejected events with HTTP 429 … Ihr Konto hat sein monatliches Event-Kontingent erreicht.
• Already initialized. Ignoring duplicate init() call. init() wurde zweimal aufgerufen. Nur der erste Aufruf zählt. Steht in der Zeile außerdem, dass der erste Aufruf keinen Schlüssel hatte, sendet die Seite bis zum nächsten Laden nichts.

Nach einem 401, 403 oder 429 sendet der Tracker nichts mehr, bis die Seite neu geladen wird.

Wie Events gesendet werden

Der Tracker sammelt Events und sendet sie alle 5 Sekunden, sobald 10 warten und wenn der Besucher die Seite verlässt. Beide Zahlen ändern Sie mit data-flush-interval und data-max-queue-size oder in Ihren Tracker-Einstellungen. Es warten höchstens 100 Events gleichzeitig. Scheitert ein Versand am Netzwerk oder am Server, gehen die Events mit dem nächsten hinaus.

Datenschutz

Der Tracker setzt keine Cookies und speichert nichts im Browser Ihrer Besucher. Was Besucher in Formulare eintippen, liest er nie. Was erfasst wird, erklärt Datenschutz.