Plausible-Analytics-Integration
Fügen Sie Ihrer Dokumentationswebsite Plausible Analytics hinzu – eine datenschutzorientierte, leichtgewichtige Alternative zu Google Analytics.
Fügen Sie Ihrer Dokumentationswebsite Plausible Analytics hinzu, um Zugriffsdaten ohne Cookies oder Tracking-Skripte zu erfassen, die Nutzer im Web verfolgen.
Plausible ist Open Source, weniger als 1 KB groß und erfordert in den meisten Rechtsordnungen kein Cookie-Einwilligungsbanner. Eine gute Wahl für einfache, DSGVO-konforme Analysen.
Wenn Sie eine Einwilligungssteuerung benötigen (oder zusätzlich GA, GTM oder Crisp verwenden), lesen Sie Cookie-Einwilligung.
Es gibt zwei Möglichkeiten, Plausible hinzuzufügen. Wählen Sie die Option, die zu Ihrem Setup passt:
| Setup | Verwenden, wenn | Feld |
|---|---|---|
| Standard | Sie den kostenlosen Plausible-Tarif verwenden oder einen kostenpflichtigen Tarif ohne Proxy benötigen | domain |
| Proxy-Skript | Sie einen kostenpflichtigen Tarif verwenden und Werbeblocker umgehen möchten | scriptUrl |
Standard-Einrichtung (domain)
Dies ist die Standardoption für die meisten Nutzer. Registrieren Sie Ihre Website bei Plausible und übergeben Sie die Domain.
Bei Plausible registrieren
Erstellen Sie ein Konto bei Plausible Analytics und fügen Sie die Domain Ihrer Dokumentationswebsite hinzu (z. B. docs.example.com).
Die Domain zu docs.json hinzufügen
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com"
}
}
}Verwenden Sie exakt die registrierte Domain: docs.example.com, nicht www.docs.example.com.
Selbst gehosteter Server
Wenn Sie die Community Edition betreiben, fügen Sie das Feld server hinzu, damit das Skript und die Event-API auf Ihre Instanz verweisen:
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com",
"server": "https://analytics.example.com"
}
}
}server funktioniert nur zusammen mit domain. Proxy-Skripte übernehmen ihr Routing selbst.
Proxy-Skript einrichten (scriptUrl)
Die kostenpflichtigen Plausible-Tarife bieten Proxy-Skripte mit einem eindeutigen Dateinamen (z. B. pa-XXXXX.js). Diese umgehen die meisten Werbeblocker, da die Skript-URL nicht den üblichen Filterlisten entspricht.
Die URL des Proxy-Skripts abrufen
Suchen Sie in den Einstellungen Ihrer Plausible-Website den Abschnitt für Proxy-Skripte und kopieren Sie die vollständige URL. Sie sieht beispielsweise so aus: https://plausible.io/js/pa-XXXXX.js.
Die Skript-URL zu docs.json hinzufügen
{
"name": "My Docs",
"integrations": {
"plausible": {
"scriptUrl": "https://plausible.io/js/pa-XXXXX.js"
}
}
}Die Felder domain oder server werden nicht benötigt. Ihre Website-Identität ist in der Skript-ID enthalten, und das CDN von Plausible übernimmt das Routing intern.
Die Installation überprüfen
Nach dem Hinzufügen der Integration:
- Lösen Sie einen neuen Build Ihrer Dokumentation aus.
- Besuchen Sie Ihre live geschaltete Dokumentationswebsite.
- Überprüfen Sie Ihr Plausible-Dashboard. Ihr Besuch sollte innerhalb weniger Sekunden erscheinen.
- Öffnen Sie alternativ die DevTools, wechseln Sie zum Tab Network und suchen Sie nach einer Anfrage an
plausible.io/js/script.js(Standard) oder nach Ihrempa-XXXXX.js-Skript (Proxy).
Plausible zeigt Daten in Echtzeit an, ohne Wartezeit wie bei Google Analytics.
Konfigurationsreferenz
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
domain | string | Eines von domain oder scriptUrl | Die bei Plausible registrierte Domain Ihrer Website. Wird als data-domain-Attribut im Skript-Tag verwendet. |
scriptUrl | string | Eines von domain oder scriptUrl | Vollständige URL zu einem kostenpflichtigen Plausible-Proxy-Skript (pa-XXXXX.js). Die Website-Identität ist im Skript hinterlegt, daher wird kein Domain-Feld benötigt. |
server | string | Nein | URL eines selbst gehosteten Plausible-Servers. Wird nur mit domain, nicht mit scriptUrl verwendet. |
Fehlerbehebung
In neun von zehn Fällen liegt es an der Domain. Sie muss exakt mit der bei Plausible registrierten Domain übereinstimmen (also docs.example.com, nicht www.docs.example.com).
Wenn die Domain korrekt aussieht:
- Erstellen Sie Ihre Dokumentation neu. Konfigurationsänderungen werden erst nach einem neuen Build wirksam.
- Überprüfen Sie die Werbeblocker. Einige Browsererweiterungen blockieren Analyseskripte, einschließlich Plausible. Wenn dies die Ursache ist, wechseln Sie zur Proxy-Skript-Einrichtung.
- Untersuchen Sie den Quelltext der Seite auf ein
<script>-Tag mitdata-domain(Standard) oder Ihren Dateinamenpa-XXXXX.js(Proxy). Wenn es nicht vorhanden ist, wurde die Konfiguration nicht angewendet.
Registrieren Sie die Domain, die Ihre Nutzer tatsächlich aufrufen. Wenn sich Ihre Dokumentation unter docs.example.com befindet, verwenden Sie diese als domain, nicht Ihre Root-Domain.
Wechseln Sie zur Proxy-Skript-Einrichtung. Der eindeutige Dateiname umgeht die Filterlisten der meisten Werbeblocker. Selbsthosting erzielt dasselbe Ergebnis, da das Skript von Ihrer eigenen Domain geladen wird.
Verwenden Sie domain, wenn Sie den kostenlosen Tarif nutzen oder Werbeblocker keine Rolle spielen. Verwenden Sie scriptUrl, wenn Sie einen kostenpflichtigen Tarif nutzen und eine maximale Abdeckung beim Tracking wünschen. Setzen Sie nicht beide Felder; wählen Sie eines aus.