Dashboard Analytics

Плагин для Payload CMS, который выводит данные Plausible и Google Analytics 4 в админ-панель: виджеты на дашборде, в навигации и на страницах коллекций.

Сообщество 185 74/нед MIT v0.3.0

Установка

pnpm add @nouance/payload-dashboard-analytics

Описание

Плагин выводит данные Plausible и Google Analytics 4 прямо в админ-панель Payload. Регистрация происходит через admin.components и расширение webpack-конфигурации: добавляются компоненты для дашборда, навигации, полей коллекций и глобальных полей. Провайдер настраивается один раз в конфигурации Payload. На дашборд добавляются виджеты viewsChart и topPages. В навигацию можно вывести индикатор текущих посетителей. На страницах коллекций и глобальных полей доступны виджеты chart и info с настраиваемыми метриками и временными диапазонами. Поддерживаемые метрики: views, visitors, sessions, sessionDuration, bounceRate. Временные диапазоны: 12mo, 6mo, 30d, 7d, currentMonth. Для привязки виджета к конкретному документу служит функция idMatcher, которая сопоставляет текущий документ с URL из аналитических данных. Плагин добавляет кастомные API-эндпоинты: globalAggregate, globalChart, pageAggregate, pageChart, live, report. По умолчанию маршруты не защищены. Опциональная функция access позволяет ограничить доступ к эндпоинтам. Чтобы не упереться в лимиты провайдера, можно включить кэш: тогда создаётся коллекция analyticsData, которая хранит ответы с настраиваемым TTL для каждого маршрута (по умолчанию 1440 минут для отчётов и 5 минут для live-данных). Для Plausible указываются source, apiSecret и siteId, а для селф-хостед-инстансов доступен параметр host. GA4 требует JSON-учётные данные сервисного аккаунта Google с правами на чтение. Плагин написан на TypeScript, зависит от @google-analytics/data и react-charts. Рассчитан на Payload 1.x и не совместим с админкой Payload 2.x/3.x, так как полагается на webpack-конфигурацию.

О пакете

Имя пакета
@nouance/payload-dashboard-analytics
Последняя версия
0.3.0
Размер
265 кБ
Лицензия
MIT
Загрузок в неделю
74
Последняя публикация
25 мая 2023 г.

Ещё от NouanceLabs

Профиль автора