insight-media / statamic-google-analytics
A Google Analytics 4 addon for Statamic
Package info
github.com/insight-media/statamic-google-analytics
pkg:composer/insight-media/statamic-google-analytics
Requires
- php: ^8.4
- google/analytics-data: ^0.10
- statamic/cms: ^6.0
Requires (Dev)
- orchestra/testbench: ^10.8
- phpunit/phpunit: ^12.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
A Google Analytics 4 addon for Statamic.
This addon provides two main features: Tracking and Analytics.
Tracking
A GA4 tracking script is injected in the views.
Analytics reporting
This addon provides analytics widgets and an analytics reporting tab per entry.
Installation
Requires PHP 8.4 or later and Statamic 6 (Laravel 12 or later).
You can install the package via composer:
composer require insight-media/statamic-google-analytics
You can optionally publish the config file with:
php artisan vendor:publish --tag="statamic-google-analytics-config"
Configuration
Tracking
In your .env:
Set your Tracking ID (string)
GA_TRACKING_ID
Users with control panel access should not be tracked (bool)
GA_IGNORE_ADMINS
Tracking should only be active in production environment (bool)
GA_PRODUCTION_ONLY
Add the tracking script to your antler views:
{{ ga }}
Analytics reporting
Path to credentials file in your storage folder (string)
GA_CREDENTIALS_PATH
Property ID (string)
GA_PROPERTY_ID
Number of days for the analytics to show data (int)
GA_DAYS
Show analytics per entry (having a slug) (bool)
GA_PAGE_GRAPH
Widgets
Configure the widgets in your config/statamic/cp.php widgets key
[ 'type' => 'analytics', 'group' => 'totalVisitorsAndPageViews|topReferrers|mostVisitedPages|topBrowsers|topcountries', 'width' => 50, 'display' => 'table|bar|line|pie|doughnut' ]
Development
Install PHP dependencies before JavaScript dependencies so Statamic's Vite tooling is available:
composer install yarn install yarn build composer phpunit
Use yarn dev to start the Vite development server. Node.js 20.19+ or 22.12+ is required.
The compiled control panel assets in resources/dist/build are included with the addon.
After upgrading an existing site, run php artisan vendor:publish --tag=statamic-google-analytics --force to publish the new assets.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
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.