Enhanced Analytics - a Statamic Addon

A powerful analytics addon for Statamic that provides detailed insights into your website's traffic and user behavior.

Features

📊 Real-Time Analytics

Page view tracking with automatic data processing
Unique visitor identification and session management
Configurable processing frequency (default: every 15 minutes)
Automatic data aggregation for efficient querying

👥 Visitor Insights

Total visits and unique visitors
New vs returning visitors
Session duration and pages per session
Bounce rate and exit rate analysis
User flow tracking (entry pages, engaged pages, exit pages)

🌍 Geographic Data

IP-based geolocation using ip-api.com
Country and city-level tracking
Built-in rate limiting (45 requests/minute)
Automatic caching of geolocation data
Configurable cache duration

💻 Technical Insights

Device type tracking (desktop, mobile, tablet)
Browser and platform detection
Referrer URL tracking
User agent analysis

⚡ Performance Features

Efficient data caching system
Support for file caching
Automatic cleanup of old data
Chunk-based processing to prevent memory issues
Lock system to prevent concurrent processing

🎨 Dashboard Features

Clean, modern interface with dark mode support
Polled data refresh
Customizable date ranges (24h, 7d, 30d, custom)
Comparative metrics with previous periods
Export functionality for detailed analysis
Interactive charts and visualizations

🔒 Privacy & Security

Built-in consent management system (disabled by default)
No external service dependencies
Complete data ownership
Configurable IP address exclusions
Bot filtering
Authenticated user tracking options
Granular consent controls for visitors
Optional geolocation tracking toggle

Installation

Install the package via Composer:


composer require mohammedshuaau/enhanced-analytics

Publish the configuration:


php artisan vendor:publish --tag=enhanced-analytics-config

Run the migrations:


php artisan migrate

Configuration

The addon can be configured via the config/enhanced-analytics.php file:


return [


    'cache' => [


        'driver' => 'file', // Options: 'file', 'redis'


        'file' => [


            'path' => storage_path('app/enhanced-analytics'),


            'permissions' => [


                'file' => 0644,


                'directory' => 0755


            ]


        ]


    ],

 

    'geolocation' => [


        'cache_duration' => 1440, // 24 hours


        'rate_limit' => 45 // requests per minute


    ],

 

    'processing' => [


        'frequency' => 15, // minutes


        'chunk_size' => 1000,


        'lock_timeout' => 60


    ],

 

    'tracking' => [


        'exclude_paths' => [


            'cp/*',


            'api/*'


        ],


        'exclude_ips' => [],


        'exclude_bots' => true,


        'track_authenticated_users' => true,


        'consent' => [


            'enabled' => false, // Set to true to enable consent banner


            'banner' => [


                'title' => 'Privacy Notice',


                'description' => 'We use analytics to understand how you use our website and improve your experience.',


                'accept_button' => 'Accept',


                'decline_button' => 'Decline',


                'settings_button' => 'Customize',


                'position' => 'bottom', // options: bottom, top, center


            ],


        ],


    ]

];

Consent Banner Configuration

The addon includes a privacy-focused consent banner that's disabled by default. Here's how to configure it:

Enable the consent banner by setting tracking.consent.enabled to true in your config file.
Add the consent banner and CSRF token (header meta tag) to your layout:

{{ enhanced_analytics:consent_banner }}


<meta name="csrf-token" content="{{ csrf_token }}">

Customize the banner appearance and text:


'consent' => [


    'enabled' => true,


    'banner' => [


        'title' => 'Your Custom Title',


        'description' => 'Your custom description about tracking.',


        'accept_button' => 'Allow Tracking',


        'decline_button' => 'No Thanks',


        'settings_button' => 'Preferences',


        'position' => 'bottom', // Available options: bottom, top, center


    ],

],

Customizing the Consent Banner Template

You can fully customize the consent banner's appearance by publishing and editing its template:

Publish the consent banner template:


php artisan vendor:publish --tag="enhanced-analytics-views"

Edit the template at:

resources/views/vendor/enhanced-analytics/components/consent-banner.antlers.html

The template uses Alpine.js for interactivity and Tailwind CSS for styling. You can modify the HTML structure, styling, and behavior while maintaining the core functionality through the following data attributes:

x-data="consentBanner": The main component
x-model="settings.geolocation": Geolocation toggle binding
x-on:click="accept": Accept button action
x-on:click="decline": Decline button action
x-on:click="toggleSettings": Settings toggle action

The consent banner includes:

Essential analytics toggle (always enabled)
Optional geolocation tracking toggle
Persistent settings through session storage
Responsive design with dark mode support

When enabled, tracking will only begin after the visitor provides consent. Their preferences are saved and respected across sessions.

Usage

Once installed, the addon will automatically start tracking page visits. Access the analytics dashboard via the Control Panel under Tools > Analytics.

Automatic Processing

The addon automatically processes analytics data via Scheduler. You might want to run the scheduler and the addon will handle the rest. You can always set the minutes the command should execute.

Manual Processing

You can manually process analytics data using the command:


php artisan analytics:process

Data Export

Export detailed analytics data directly from the dashboard in CSV format for further analysis.

Performance Considerations

The addon uses efficient caching and processes data in chunks to maintain performance
Geolocation data is cached to respect API rate limits
Database queries are optimized using aggregates for faster dashboard loading
Automatic cleanup of old cache data

Upcoming Features

Support for Redis Driver

Contributing

Contributions are always welcome!

Development Guidelines

Follow PSR-12 coding standards
Add appropriate comments and documentation
Update the README.md with details of significant changes
Add/update tests as needed
Ensure all tests pass before submitting PR

Testing

Run the test suite:

vendor/bin/phpunit

Support

If you discover any security-related issues, please use the issue tracker to report them.

License

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