statamic-privacy-analytics

A self-hosted, privacy-first analytics addon for Statamic. No Google. No third-party scripts. No cookies by default. Your data stays on your server.

Fork of mohammedshuaau/enhanced-analytics — significantly extended and refactored.

Why this addon?

• Zero external tracking dependencies — no Google Analytics, no Matomo cloud, no Plausible cloud
• Direct DB writes — every page view is recorded instantly, no processing queue needed for real-time data
• GDPR-ready — built-in consent banner with granular controls (optional)
• Geolocation — IP → country/city via ip-api.com (HTTP, free tier) or locally with MaxMind GeoLite2 (no external calls)

Features

Dashboard

• Date ranges : 24h, 7 days, 30 days, custom
• Comparison with previous period (visits, unique visitors, bounce rate)
• CSV export
• Auto-refresh (configurable interval)
• Dark mode support

Widgets

CP Dashboard Widget

A compact widget is automatically injected into the Statamic Control Panel dashboard, displaying at-a-glance stats for the last 7 days:

• Visits today
• Total page views (7 days)
• Unique visitors (7 days)

The widget links directly to the analytics dashboard. It is auto-injected if no analytics_overview entry is already present in config/statamic/cp.php. To control its position or width, add it explicitly:

// config/statamic/cp.php
'widgets' => [
    ['type' => 'analytics_overview', 'width' => 50],
    // ...
],

Privacy & tracking

• Consent banner (disabled by default) with granular controls
• Bot filtering
• Configurable excluded paths and IPs
• Optional authenticated user tracking
• Geolocation optional per-visitor via consent settings
• Three providers : ip-api (external HTTP), maxmind (local database, no external calls), disabled

Requirements

• PHP ≥ 8.3
• Statamic ≥ 6.0
• MariaDB / MySQL

Installation

composer require oliweb/statamic-privacy-analytics

Publish the configuration:

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

Run the migrations:

php artisan migrate

The addon starts tracking immediately. Access the dashboard via Control Panel → Tools → Analytics.

Configuration

config/statamic-analytics.php :

return [
    'geolocation' => [
        'provider'       => env('ANALYTICS_GEO_PROVIDER', 'ip-api'), // 'disabled' | 'ip-api' | 'maxmind'
        'cache_duration' => 1440, // minutes (24h)
 
        'ip_api' => [
            'rate_limit' => 45, // requests per minute (ip-api.com free tier)
        ],
 
        'maxmind' => [
            'database_path' => storage_path('app/geoip/GeoLite2-City.mmdb'),
            'account_id'    => env('MAXMIND_ACCOUNT_ID'),
            'license_key'   => env('MAXMIND_LICENSE_KEY'),
        ],
    ],
 
    'processing' => [
        'frequency'    => 15, // minutes — aggregate recalculation frequency
        'lock_timeout' => 60,
    ],
 
    'dashboard' => [
        'refresh_interval' => 300, // seconds
    ],
 
    'tracking' => [
        'exclude_paths' => ['cp/*', 'api/*'],
        'exclude_ips'   => [],
        'exclude_bots'  => true,
        'track_authenticated_users' => true,
        'consent' => [
            'enabled' => false, // set to true to require visitor consent
            'banner'  => [
                'title'          => 'Privacy Notice',
                'description'    => 'We use analytics to understand how visitors use our site.',
                'accept_button'  => 'Accept',
                'decline_button' => 'Decline',
                'settings_button'=> 'Customize',
                'position'       => 'bottom', // bottom | top | center
            ],
        ],
    ],
];

Geolocation

Providers

Set via .env:

ANALYTICS_GEO_PROVIDER=maxmind

MaxMind GeoLite2 (recommended for full privacy)

1. Create a free account at maxmind.com/en/geolite2/signup
2. Generate a license key in My Account → Manage License Keys
3. Add to .env:

   ANALYTICS_GEO_PROVIDER=maxmind
   MAXMIND_ACCOUNT_ID=<your_account_id>
   MAXMIND_LICENSE_KEY=<your_license_key>

4. Download the database:

   php artisan analytics:update-geoip

MaxMind updates GeoLite2 every Tuesday. To automate:

// App\Console\Kernel or routes/console.php
$schedule->command('analytics:update-geoip')->weekly()->tuesdays();

Consent banner

When tracking.consent.enabled is true, tracking only starts after visitor consent.

Add to your Antlers layout:

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

Publish and customize the template:

php artisan vendor:publish --tag=statamic-analytics-views

Template location after publishing:

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

Aggregate recalculation

The addon writes page views directly to the database on every request. A scheduled command recalculates aggregates (by country, device, browser, platform) for today and yesterday:

php artisan analytics:process

This runs automatically via Laravel Scheduler at the frequency defined in config. Make sure the scheduler is running:

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

Architecture

HTTP request
    └─ TrackPageVisit middleware
           └─ INSERT into statamic_analytics_page_views   ← direct, real-time
 
Scheduler (every N minutes)
    └─ analytics:process
           └─ DELETE + INSERT into statamic_analytics_aggregates
              (recalculated from page_views for today + yesterday)

Geolocation (IP → country/city) is resolved by the configured provider — ip-api.com (HTTP, 45 req/min free tier) or MaxMind GeoLite2 (local .mmdb file, no external calls). Results are cached for 24 hours. With provider: disabled, country/city fields stay null and no IP leaves the server.

License

MIT — see LICENSE.md.

Original work © 2024 Mohammed Shuaau. Modifications © 2026 Olivier Petrucciani (OliWeb - oliweb.ch).