repository·main·Indexed 42 days ago
https://github.com/bezhansalleh/filament-google-analyticsA Google Analytics (GA4) integration for Filament Panels that provides pre-built widgets to display analytics data directly within the Filament admin interface. Includes widgets for page views, visitors, active users, sessions, and country-based data, as well as a dedicated dashboard and the GAStatsBuilder for creating custom statistics widgets.
Add the GoogleAnalyticsPlugin to your Filament Panel provider configuration:
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
\BezhanSalleh\GoogleAnalytics\GoogleAnalyticsPlugin::make()
]);
}public function panel(Panel $panel): Panel
{
return $panel
->plugins([
...
\BezhanSalleh\GoogleAnalytics\GoogleAnalyticsPlugin::make()
]);
}BezhanSalleh\FilamentGoogleAnalytics to BezhanSalleh\GoogleAnalytics.All widgets are available to be used in Filament pages or resources.
To show widgets on the default Filament dashboard, you must publish the configuration and set the filament_dashboard option to true for each specific widget you want to enable in config/google-analytics.php.
To publish the config:
php artisan vendor:publish --tag=google-analytics-configImport the Widgets class to access the following:
Widgets\ PageViewsWidget::classWidgets\VisitorsWidget::classWidgets\ActiveUsersOneDayWidget::classWidgets\ActiveUsersSevenDayWidget::classWidgets\ActiveUsersTwentyEightDayWidget::classWidgets\SessionsWidget::classWidgets\SessionsByCountryWidget::classWidgets\SessionsDurationWidget::classWidgets\SessionsByDeviceWidget::classWidgets\MostVisitedPagesWidget::classWidgets\TopReferrersListWidget::classInstall the package into your Laravel application using Composer:
composer require bezhansalleh/filament-google-analyticsyourapp/storage/app/analytics/service-account-credentials.json..env file:ANALYTICS_PROPERTY_ID=If you are using a custom theme in Filament, you must add the plugin's resources to your theme's CSS file so Tailwind can scan them for classes:
@source '../../../../vendor/bezhansalleh/filament-google-analytics/resources/views/**/*';
@source '../../../../vendor/bezhansalleh/filament-google-analytics/src/{Widgets,Support}/*';The resolve() method handles two primary types of input via usingResponse():
GoogleAnalytics, the builder extracts trajectory values (current vs previous), descriptions, icons, colors, and chart data to create a rich GAStats object.results key, treats the last element as the current value, and generates a chart based on the full results array.If you want to customize the dashboard (e.g., change navigation labels, groups, or specific widget selection), the recommended approach is to disable the default dashboard and create a custom Filament page.
php artisan filament:page MyCustomDashboardPagegetHeaderWidgets() or getFooterWidgets():<?php
namespace App\Filament\Pages;
use Filament\Pages\Page;
use BezhanSalleh\GoogleAnalytics\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,
// Add other widgets here...
];
}
}<?php
namespace App\Filament\Pages;
use Filament\Pages\Page;
use BezhanSalleh\GoogleAnalytics\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\ActiveUsersTwentyEightDayWidget::class,
Widgets\SessionsWidget::class,
Widgets\SessionsByCountryWidget::class,
Widgets\SessionsDurationWidget::class,
Widgets\SessionsByDeviceWidget::class,
n Widgets\MostVisitedPagesWidget::class,
Widgets\TopReferrersListWidget::class,
];
}
}The Google Analytics dashboard page behavior is controlled via the google-analytics configuration file. You can customize the navigation icon and determine if the dashboard is visible.
dashboard_icon key to any Heroicon name (e.g., heroicon-m-chart-bar).dedicated_dashboard configuration key. If this is set to false, the canView() method will return false, preventing the page from being accessed.// Example configuration in config/google-analytics.php
return [
'dashboard_icon' => 'heroicon-m-presentation-chart-line',
'dedicated_dashboard' => true,
];When building statistics, you can attach selection filters and options to the builder using withSelectFilter(). This is useful for allowing users to filter the displayed data (e.g., by dimension or date range) within the UI.
$options: An array of int|string => string representing the selection choices.$filter: A string representing the specific filter to apply.$builder = GAStatsBuilder::make('Page Views')
->usingResponse($response)
->withSelectFilter(['daily' => 'Daily', 'weekly' => 'Weekly'], 'dimension_filter_key');
$gaStats = $builder->resolve();The GAStats class extends Filament's Stat class and is used to represent Google Analytics (GA4) statistics within a StatsOverviewWidget. You can use the select() method to specify which metrics/dimensions to retrieve and which filter to apply.
To configure a GAStats instance, call select() with two parameters:
$options: An associative array where keys are the metric/dimension identifiers and values are the labels to display.$filter: (Optional) A string representing the filter to apply to the data.This class provides getFilter() and getOptions() methods to retrieve the configured state.
use BezhanSalleh\GoogleAnalytics\Support\GAStats;
GAStats::make()
->select([
'activeUsers' => 'Active Users',
'sessions' => 'Sessions',
], 'some-filter-string');The GAStatsBuilder is used to transform raw Google Analytics data or GoogleAnalytics response objects into a structured GAStats object suitable for display in Filament. You can initiate the builder using the make() static method, providing a heading and an optional type.
To complete the construction, you must provide a response via usingResponse() and then call resolve() to return the final GAStats instance.
use BezhanSalleh\GoogleAnalytics\Support\GAStatsBuilder;
$gaStats = GAStatsBuilder::make('Total Users', 'users')
->usingResponse($googleAnalyticsResponse)
->resolve();The GoogleAnalytics facade provides a convenient proxy to the underlying FilamentGoogleAnalytics class. You can use it to access core functionality such as formatting numbers or retrieving analytics data via the for() method.
use BezhanSalleh//GoogleAnalytics//Facades//GoogleAnalytics;
// Example usage of available facade methods:
$formatted = GoogleAnalytics::thousandsFormater();
$analytics = GoogleAnalytics::for($propertyId);