README

Filament Google Analytics

Google Analytics integration for Filament (FilamentAdmin)

Installation

You can install the package in to a Laravel app that uses Filament via composer:

composer require hankiao/filament-google-analytics

For now, follow the directions on Spatie's Laravel Google Analytics package for getting your credentials, then put them here:

yourapp/storage/app/analytics/service-account-credentials.json

Also add this to the .env for your Filament PHP app:

ANALYTICS_VIEW_ID=

Usage

All the widgets are enabled by default in a dedicated Google Analytics Dashboard. You can enable or disable a specific widget or the dedicated dashboard all together or show and hide some from the main Filament Dashboard from the config filament-google-analytics.

Publish the config files and set your settings:

php artisan vendor:publish --tag=filament-google-analytics-config

Available Widgets

\hankiao\FilamentGoogleAnalytics\Widgets\PageViewsWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\VisitorsWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\ActiveUsersOneDayWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\ActiveUsersSevenDayWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\ActiveUsersFourteenDayWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\ActiveUsersTwentyEightDayWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\SessionsWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\SessionsDurationWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\SessionsByCountryWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\SessionsByDeviceWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\MostVisitedPagesWidget::class,
\hankiao\FilamentGoogleAnalytics\Widgets\TopReferrersListWidget::class,

Custom Dashboard

Though this plugin comes with a default dashboard, but sometimes you might want to change navigationLabel or navigationGroup or disable some widgets or any other options and given that the dashboard is a simple filament page; The easiest solution would be to disable the default dashboard and create a new page:

php artisan filament:page MyCustomDashboardPage

then register the widgets you want from the Available Widgets list either in the getHeaderWidgets() or getFooterWidgets():

<?php

namespace App\Filament\Pages;

use Filament\Pages\Page;
use hankiao\FilamentGoogleAnalytics\Widgets;

class MyCustomDashboardPage extends Page
{
    protected static ?string $navigationIcon = 'heroicon-o-document-text';

    protected static string $view = 'filament.pages.my-custom-dashboard-page';

    protected function getHeaderWidgets(): array
    {
        return [
            Widgets\PageViewsWidget::class,
            Widgets\VisitorsWidget::class,
            Widgets\ActiveUsersOneDayWidget::class,
            Widgets\ActiveUsersSevenDayWidget::class,
            Widgets\ActiveUsersFourteenDayWidget::class,
            Widgets\ActiveUsersTwentyEightDayWidget::class,
            Widgets\SessionsWidget::class,
            Widgets\SessionsDurationWidget::class,
            Widgets\SessionsByCountryWidget::class,
            Widgets\SessionsByDeviceWidget::class,
            Widgets\MostVisitedPagesWidget::class,
            Widgets\TopReferrersListWidget::class,
        ];
    }
}

Features

View the Visitors and Pageview Metrics

View the Active Users Metrics

View the Sessions and Avg. Session Duration Metrics

View the Devices and Country Metrics by Session (WIP)

View the lists of Most Visited Pages and Referrers

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

If you want to contribute to this packages, you may want to test it in a real Filament project:

Fork this repository to your GitHub account.
Create a Filament app locally.
Clone your fork in your Filament app's root directory.
In the /filament-google-analytics directory, create a branch for your fix, e.g. fix/error-message.

Install the packages in your app's composer.json:

"require": {
    "hankiao/filament-google-analytics": "dev-fix/error-message as main-dev",
},
"repositories": [
    {
        "type": "path",
        "url": "filament-google-analytics"
    }
]

Now, run composer update.

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

hankiao / filament-google-analytics

Maintainers

Details