API-Referenz

Sie können das Verhalten des Metricalp-Skripts anpassen und konfigurieren, indem Sie einige Datenattribute bereitstellen. Wenn Sie Integrationsbibliotheken wie für React und NextJS verwenden, können Sie diese Einstellungen plattformspezifisch bereitstellen (als Komponenten-Props für React). Überprüfen Sie daher die integrationsspezifische Dokumentation Ihrer Plattform. Alle Konfigurationen werden 1:1 übereinstimmen, daher können Sie diese Dokumentation für Erklärungen überprüfen. Wenn Sie das reine Skript einbetten, können Sie die folgenden Einstellungen mit Datenattributen bereitstellen. Alle Datenattribute sind optional, außer data-tid.

data-tid

ErforderlichTyp: stringStandardwert: -

Dies ist Ihre tid, auch bekannt als Tracker-ID. Informationen dazu, wie Sie diese erhalten, finden Sie in Tracker-Einstellungen / Einbetten & Teilen. Sie müssen dieses Attribut bereitstellen, damit Metricalp funktioniert.

data-allow-localhost

OptionalTyp: "true" oder "false" Zeichenfolgen, da HTML-Attribute nur Zeichenfolgenwerte akzeptierenStandardwert: "false"

Wenn Sie Metricalp auf Ihrem localhost zu Testzwecken integrieren, können Sie dieses Attribut auf "true" setzen. Andernfalls wird Metricalp keine Ereignisse auf localhost sammeln, um Ihr Nutzungskontingent zu sparen. Überprüfen Sie diese Dokumentation für detaillierte Informationen Wenn Sie bestimmte Hostnamen in Ihren Tracker-Einstellungen zulassen, fügen Sie bitte auch localhost zu den zugelassenen Hostnamen hinzu.

data-custom-event-endpoint

OptionalTyp: stringStandardwert: "https://event.metricalp.com"

Wenn Sie den Ereignis-Endpunkt von Metricalp proxyen, um Werbeblocker zu umgehen, verwenden Sie dieses Attribut, um den proxyierten Endpunkt bereitzustellen. Überprüfen Sie diese Dokumentation für detaillierte Informationen.

data-disable-auto-route-catch

OptionalTyp: "true" oder "false" Zeichenfolgen, da HTML-Attribute nur Zeichenfolgenwerte akzeptierenStandardwert: "false"

Standardmäßig hört Metricalp auf window.history-Ereignisse, um Routenänderungen in JS-Anwendungen zu erfassen. Sie können dies deaktivieren, indem Sie dieses Attribut auf true setzen, und dann können Sie Routen manuell verfolgen.

data-hash-routing

OptionalTyp: "true" oder "false" Zeichenfolgen, da HTML-Attribute nur Zeichenfolgenwerte akzeptierenStandardwert: "false"

Wenn Ihre Anwendung Hash-Routing verwendet (example.com/#about, example.com/#homepage), können Sie dieses Attribut auf true setzen. Dann wird Metricalp auf Änderungen der Hash-Routen hören.

data-disable-custom-elm-events

OptionalTyp: "true" oder "false" Zeichenfolgen, da HTML-Attribute nur Zeichenfolgenwerte akzeptierenStandardwert: "false"

Metricalp unterstützt standardmäßig das Tracking benutzerdefinierter Ereignisse basierend auf HTML-Attributen. Wie <button data-metricalp-event="follow click" data-metricalp-user="John">Click</button>, wird ein Klick auf diese Schaltfläche ein benutzerdefiniertes Ereignis mit dem Namen "follow click" und einer benutzerdefinierten Eigenschaft "user" mit dem Wert "John" erstellen. Sie können diese Funktion deaktivieren, indem Sie dieses Attribut auf true setzen. Überprüfen Sie diese Dokumentation für detaillierte Informationen