https://github.com/bezhansalleh/filament-google-analytics
Google Analytics integration with Filamentphp (FilamentAdmin)
https://github.com/bezhansalleh/filament-google-analytics
analytics filament-analytics filamentadmin filamentphp google-analytics laravel livewire
Last synced: 5 months ago
JSON representation
Google Analytics integration with Filamentphp (FilamentAdmin)
- Host: GitHub
- URL: https://github.com/bezhansalleh/filament-google-analytics
- Owner: bezhanSalleh
- License: mit
- Created: 2022-02-21T18:26:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T13:37:39.000Z (about 1 year ago)
- Last Synced: 2025-05-15T10:06:19.383Z (about 1 year ago)
- Topics: analytics, filament-analytics, filamentadmin, filamentphp, google-analytics, laravel, livewire
- Language: PHP
- Homepage:
- Size: 1.18 MB
- Stars: 188
- Watchers: 5
- Forks: 34
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Google Analytics (GA4)
Google Analytics integration for [Filament Panels](https://filamentphp.com) with a set of widgets to display your analytics data in a beautiful way.
#### Compatibility
| Package Version | Filament Version |
|----------------|---------------------|
| [1.x](https://github.com/bezhanSalleh/filament-google-analytics/tree/1.x) | [2.x](https://filamentphp.com/docs/2.x/admin/installation) |
| [2.x](https://github.com/bezhanSalleh/filament-google-analytics/tree/2.x) | [3.x](https://filamentphp.com/docs/3.x/panels/installation) |
| 3.x | [4.x](https://filamentphp.com/docs/4.x/introduction/overview) & [5.x](https://filamentphp.com/docs/4.x/introduction/overview) |
## Upgrading from v2 to v3
If you are upgrading from version 2 to version 3, you will need to update the namespace anywhere you are using the plugin from `BezhanSalleh\FilamentGoogleAnalytics` to `BezhanSalleh\GoogleAnalytics`.
# Installation
You can install the package in to a Laravel app that uses [Filament](https://filamentphp.com) via composer:
```bash
composer require bezhansalleh/filament-google-analytics
```
For now, follow the directions on [Spatie's Laravel Google Analytics package](https://github.com/spatie/laravel-analytics) 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:
```ini
ANALYTICS_PROPERTY_ID=
```
> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.
After setting up a custom theme add the following to your theme css file.
```css
@source '../../../../vendor/bezhansalleh/filament-google-analytics/resources/views/**/*';
@source '../../../../vendor/bezhansalleh/filament-google-analytics/src/{Widgets,Support}/*';
```
```php
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
...
\BezhanSalleh\GoogleAnalytics\GoogleAnalyticsPlugin::make()
]);
}
```
# Usage
All the widgets are enabled by default for you to use them in your filament pages/resources. In order to enable the widgets for the default filament dashboard, you need to set the `filament_dashboard` option to `true` in the config file `google-analytics.php` for each widget you want to enable.
Publish the config files and set your settings:
```bash
php artisan vendor:publish --tag=google-analytics-config
```
#### Available Widgets
```php
use BezhanSalleh\GoogleAnalytics\Widgets;
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,
Widgets\MostVisitedPagesWidget::class,
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`:
```bash
php artisan filament:page MyCustomDashboardPage
```
then register the widgets you want from the **Available Widgets** list either in the `getHeaderWidgets()` or `getFooterWidgets()`:
```php
[!NOTE]
> In order to enable the widgets for the default filament dashboard, you need to set the `filament_dashboard` option to `true` in the config file `google-analytics.php` for each widget you want to enable.
# Preview
Widgets rendered in a dedicated dashboard (or any other page you create)
# Changelog
Please see [CHANGELOG](CHANGELOG.md) 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`:
```json
"require": {
"bezhansalleh/filament-google-analytics": "dev-fix/error-message as main-dev",
},
"repositories": [
{
"type": "path",
"url": "filament-google-analytics"
}
]
```
Now, run `composer update`.
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
# Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
# Credits
- [Bezhan Salleh](https://github.com/bezhanSalleh)
- [Laravel Analytics](https://github.com/spatie/laravel-analytics) By [Spatie](https://github.com/spatie)
- [Nova Google Analytics](https://github.com/tighten/nova-google-analytics) By [Tighten](https://github.com/tighten)
- [All Contributors](../../contributors)
# License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.