README

Filament Metrics Fathom

A Filament plugin that integrates Fathom Analytics into your admin panel. Get real-time visitor counts, pageview charts, top pages, referrers, browsers, countries and device breakdowns — all from your Filament dashboard.

Features

• Settings page to configure Fathom API credentials directly from the panel
• 7 ready-to-use dashboard widgets (stats, charts, tables)
• Real-time visitor count with automatic polling (every 30s)
• Caching built-in to respect Fathom API rate limits (10 req/min)
• Multi-language support (English and Brazilian Portuguese)
• Fully configurable: enable/disable settings page and widgets independently

Version Compatibility

Requirements

• PHP 8.2+
• Filament ^5.0
• jeffersongoncalves/laravel-metrics-fathom ^1.0
• filament/spatie-laravel-settings-plugin ^5.0

Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-metrics-fathom:"^3.0"

Publish and run the settings migration from the base package:

php artisan vendor:publish --tag="metrics-fathom-settings"
php artisan migrate

Setup

Register the plugin in your Filament panel provider:

use JeffersonGoncalves\Filament\MetricsFathom\FathomMetricsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(FathomMetricsPlugin::make());
}

Configuration

You can enable or disable features individually:

FathomMetricsPlugin::make()
    ->settingsPage(false) // Disable the settings page
    ->widgets(false)      // Disable all widgets

Widgets

The plugin provides 7 dashboard widgets:

All widgets include:

• Automatic error handling with user-friendly messages
• "Not Configured" state when API token is missing
• Built-in caching to respect Fathom API rate limits
• Multi-language support (English and Portuguese)

Translations

The plugin supports English (en) and Brazilian Portuguese (pt_BR). You can publish the translations:

php artisan vendor:publish --tag="filament-metrics-fathom-translations"

Testing

composer test

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

• Jefferson Goncalves
• All Contributors

License

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