Integration von Plausible Analytics
Fügen Sie Plausible Analytics, eine schlanke, cookiefreie Alternative zu Google Analytics, zu Ihrer Dokumentationsseite hinzu.
Fügen Sie Plausible Analytics zu Ihrer Dokumentationsseite hinzu, um Trafficdaten ohne Cookies oder seitenübergreifendes Tracking zu erhalten.
Plausible ist Open Source und wiegt weniger als 1 KB. In den meisten Rechtsräumen ist für Plausible kein Cookie-Einwilligungsbanner erforderlich.
Falls Sie dennoch eine Einwilligungssteuerung benötigen (oder zusätzlich GA, GTM oder Crisp einsetzen), lesen Sie Cookie-Einwilligung.
Wählen Sie eine von zwei Einrichtungsvarianten:
| Einrichtung | Verwenden, wenn | Feld |
|---|---|---|
| Standard | Sie den kostenlosen Plausible-Tarif nutzen oder einen kostenpflichtigen Tarif ohne Proxy-Bedarf | domain |
| Proxy-Skript | Sie einen kostenpflichtigen Tarif nutzen und Werbeblocker umgehen möchten | scriptUrl |
Standard-Einrichtung (domain)
Die meisten Seiten verwenden diese Einrichtung. Registrieren Sie Ihre Seite in Plausible und übergeben Sie die Domain.
Bei Plausible registrieren
Erstellen Sie ein Konto unter Plausible Analytics und fügen Sie die Domain Ihrer Dokumentationsseite hinzu (z. B. docs.example.com).
Die Domain zu docs.json hinzufügen
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com"
}
}
}Verwenden Sie genau die Domain, die Sie registriert haben: docs.example.com, nicht www.docs.example.com.
Selbst gehosteter Server
Falls Sie die Community Edition betreiben, fügen Sie das Feld server hinzu. Es leitet Skript und Event-API an Ihre Instanz weiter:
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com",
"server": "https://analytics.example.com"
}
}
}server funktioniert nur zusammen mit domain. Proxy-Skripte übernehmen ihr eigenes Routing.
Proxy-Skript einrichten (scriptUrl)
Die kostenpflichtigen Tarife von Plausible bieten Proxy-Skripte mit einem eindeutigen Dateinamen (etwa pa-XXXXX.js). Diese umgehen die meisten Werbeblocker, da die Skript-URL nicht in gängigen Filterlisten steht.
Die URL des Proxy-Skripts abrufen
Suchen Sie in den Einstellungen Ihrer Plausible-Seite den Bereich Proxy-Skript und kopieren Sie die vollständige URL. Sie sieht etwa 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"
}
}
}Lassen Sie domain und server weg. Die Skript-ID trägt Ihre Seitenidentität. Das CDN von Plausible leitet Anfragen intern weiter.
Die Installation überprüfen
Prüfen Sie, ob Daten eingehen:
- Lösen Sie einen Neuaufbau Ihrer Dokumentation aus
- Besuchen Sie Ihre Live-Dokumentationsseite
- Prüfen Sie Ihr Plausible-Dashboard. Ihr Besuch sollte innerhalb weniger Sekunden erscheinen.
- Oder öffnen Sie die DevTools, wechseln Sie zum Tab Netzwerk und suchen Sie nach einer Anfrage an
plausible.io/js/script.js(Standard) bzw. Ihr Skriptpa-XXXXX.js(Proxy)
Plausible zeigt Daten in Echtzeit an, ohne Wartezeit wie bei Google Analytics.
Konfigurationsreferenz
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
domain | string | Eines von domain oder scriptUrl | Die Domain Ihrer Seite, wie sie in Plausible registriert ist. Wird als Attribut data-domain am Skript-Tag verwendet. |
scriptUrl | string | Eines von domain oder scriptUrl | Vollständige URL eines kostenpflichtigen Plausible-Proxy-Skripts (pa-XXXXX.js). Die Seitenidentität ist im Skript hinterlegt. Ein Domain-Feld ist nicht nötig. |
server | string | Nein | URL eines selbstgehosteten Plausible-Servers. Wird nur mit domain verwendet, nicht mit scriptUrl. |
Fehlerbehebung
Die häufigste Ursache ist die Domain. Sie muss exakt mit der in Plausible registrierten übereinstimmen (docs.example.com, nicht www.docs.example.com).
Falls die Domain stimmt:
- Bauen Sie Ihre Dokumentation neu. Konfigurationsänderungen wirken erst nach einem neuen Build.
- Prüfen Sie auf Werbeblocker. Manche Browser-Erweiterungen blockieren Analyse-Skripte, darunter auch Plausible. Wenn das die Ursache ist, wechseln Sie zur Proxy-Skript-Einrichtung.
- Prüfen Sie den Quelltext der Seite auf ein
<script>-Tag mitdata-domain(Standard) bzw. Ihrem Dateinamenpa-XXXXX.js(Proxy). Fehlt es, wurde die Konfiguration nicht übernommen.
Registrieren Sie die Domain, die Ihre Leser aufrufen. Liegt Ihre Dokumentation unter docs.example.com, verwenden Sie diese als domain, nicht Ihre Hauptdomain.
Wechseln Sie zur Proxy-Skript-Einrichtung. Der eindeutige Dateiname umgeht die meisten Filterlisten von Werbeblockern. Auch das Selbsthosting umgeht Werbeblocker, da das Skript von Ihrer eigenen Domain geladen wird.
Verwenden Sie domain, wenn Sie den kostenlosen Tarif nutzen oder sich nicht um Werbeblocker kümmern. Verwenden Sie scriptUrl, wenn Sie einen kostenpflichtigen Tarif haben und maximale Tracking-Abdeckung wünschen. Setzen Sie nicht beide.