Dashboard Analytics

Über

Das Plugin bindet Analytics-Daten von Plausible oder Google Analytics 4 in die Payload-Adminoberfläche ein. Die Provider-Konfiguration erfolgt einmal in der Payload-Config. Für Plausible werden ein API-Secret und eine Site-ID benötigt, für GA4 ein Google Service-Account mit Leserechten im JSON-Format. Selbstgehostete Plausible-Instanzen lassen sich über die optionale Host-Angabe anbinden. Auf dem Dashboard stehen ein Views-Diagramm (viewsChart) und eine Top-Pages-Liste (topPages) zur Verfügung. In der Navigation wird ein optionaler Indikator für aktuelle Besucher eingeblendet. Collections und Globals erhalten pro Dokument Chart- und Info-Widgets, die über eine idMatcher-Funktion das aktuelle Dokument einer URL in den Analytics-Daten zuordnen. Als Metriken lassen sich views, visitors, sessions, sessionDuration und bounceRate auswählen, als Zeiträume 12mo, 6mo, 30d, 7d und currentMonth. Sechs eigene API-Endpunkte liefern die Daten: globalAggregate, globalChart, pageAggregate, pageChart, live und report. Die Routen sind standardmäßig ungeschützt. Eine optionale access-Funktion schränkt den Zugriff auf authentifizierte Nutzer ein. Um Rate-Limits der Provider zu vermeiden, kann ein Cache aktiviert werden, der die Collection analyticsData anlegt und Antworten mit pro Route konfigurierbaren TTLs speichert. Die Standardwerte liegen bei 1440 Minuten für Reports und 5 Minuten für Live-Daten. Abhängigkeiten sind @google-analytics/data und react-charts. Das Plugin ist in TypeScript geschrieben und zielt auf Payload 1.x (peerDep payload ^1.6.16, React 16/17/18). Die UI-Komponenten werden über admin.components und Webpack-Erweiterungen registriert, daher ist das Plugin nicht mit der Adminoberfläche von Payload 2.x oder 3.x kompatibel.

Paketinformationen

Paketname

@nouance/payload-dashboard-analytics

Neueste Version

0.3.0

Entpackte Größe

265 kB

Lizenz

MIT

Wöchentliche Downloads

74

Zuletzt veröffentlicht

25. Mai 2023