feat: Major package improvements and new features

- Fixed critical RequestDataDTO typo bug
- Added database indexes for improved query performance
- Fixed response time data type consistency
- Implemented comprehensive bot/crawler detection
- Added IP geolocation service with multiple providers
- Implemented caching layer for analytics queries
- Added unique visitor tracking with cookies
- Created comprehensive REST API endpoints
- Added data export functionality (CSV and JSON)
- Implemented GDPR compliance features
- Added comprehensive test suite
- Updated documentation

New features include bot detection, geolocation, visitor tracking, API endpoints, data export, and privacy compliance options.

Author: me-shaon

README.md

@@ -43,20 +43,32 @@ return [
     'capture' => [
         'web' => true,
         'api' => true,
+        'bots' => false, // Set to true to capture bot traffic
     ],
 
     'queue' => [
-        'enabled' => env('REQUEST_ANALYTICS_QUEUE_ENABLED', true),
+        'enabled' => env('REQUEST_ANALYTICS_QUEUE_ENABLED', false),
     ],
 
     'ignore-paths' => [
-
+        // Add paths to ignore, e.g., 'admin', 'api/health'
     ],
 
     'pruning' => [
         'enabled' => env('REQUEST_ANALYTICS_PRUNING_ENABLED', true),
         'days' => env('REQUEST_ANALYTICS_PRUNING_DAYS', 90),
     ],
+
+    'geolocation' => [
+        'enabled' => env('REQUEST_ANALYTICS_GEO_ENABLED', true),
+        'provider' => env('REQUEST_ANALYTICS_GEO_PROVIDER', 'ipapi'), // ipapi, ipgeolocation, maxmind
+        'api_key' => env('REQUEST_ANALYTICS_GEO_API_KEY'),
+    ],
+
+    'privacy' => [
+        'anonymize_ip' => env('REQUEST_ANALYTICS_ANONYMIZE_IP', false),
+        'respect_dnt' => env('REQUEST_ANALYTICS_RESPECT_DNT', true), // Respect Do Not Track header
+    ],
 ];
 ```
 ### Data Purning 
@@ -114,17 +126,65 @@ Optionally, you can publish the views using
 php artisan vendor:publish --tag="request-analytics-views"
 ```
 
+## Features
+
+- 📊 **Real-time Analytics Dashboard** - Beautiful, responsive dashboard with charts and metrics
+- 🤖 **Bot Detection** - Automatically filters out bot traffic (configurable)
+- 🌍 **IP Geolocation** - Track visitor locations using multiple providers
+- 🔒 **Privacy Focused** - GDPR compliant with IP anonymization and DNT support
+- 🚀 **High Performance** - Built-in caching and optimized database queries
+- 📱 **Device Detection** - Track browsers, operating systems, and devices
+- 👥 **Visitor Tracking** - Unique visitor identification with cookie-based tracking
+- 📤 **Export Data** - Export analytics data to CSV or JSON formats
+- 🔌 **REST API** - Full-featured API for programmatic access
+- 🧹 **Auto Cleanup** - Automatic data pruning to manage database size
+
 ## Usage
 
-```php
-$requestAnalytics = new MeShaon\RequestAnalytics();
-echo $requestAnalytics->echoPhrase('Hello, MeShaon!');
-```
+### Dashboard Access
+
+After installation, the analytics dashboard is available at `/analytics` (configurable). Users must be authenticated and implement the `CanAccessAnalyticsDashboard` interface.
+## API Endpoints
+
+The package provides a comprehensive REST API for accessing analytics data:
+
+- `GET /api/v1/analytics/overview` - Get analytics overview with summary and charts
+- `GET /api/v1/analytics/visitors` - Get paginated visitor data
+- `GET /api/v1/analytics/page-views` - Get paginated page view data
+- `POST /api/v1/analytics/export` - Export analytics data to CSV or JSON
+
+### API Authentication
+
+API endpoints use Laravel Sanctum for authentication. Ensure your API consumers have valid tokens.
+
+## Configuration Options
+
+### Geolocation Providers
+
+The package supports multiple geolocation providers:
+
+1. **IP-API** (default, free): No API key required, limited to 45 requests per minute
+2. **IPGeolocation**: Requires API key from [ipgeolocation.io](https://ipgeolocation.io)
+3. **MaxMind**: Requires GeoIP2 database or web service account
+
+### Privacy Settings
+
+- **IP Anonymization**: Enable to anonymize the last octet of IPv4 addresses
+- **Do Not Track**: Respect the DNT browser header (enabled by default)
+
+### Bot Detection
+
+The package automatically detects and filters common bots and crawlers including:
+- Search engine bots (Google, Bing, Yahoo, etc.)
+- Social media bots (Facebook, Twitter, LinkedIn, etc.)
+- SEO tools (Ahrefs, SEMrush, etc.)
+- Monitoring services (Pingdom, UptimeRobot, etc.)
+- Development tools (curl, wget, Postman, etc.)
+
 ## Access Control
 
 ### Web Access
 To control access to the dashboard, implement the `CanAccessAnalyticsDashboard` interface in your User model:
-Then you can use the `canAccessAnalyticsDashboard` method in your your `User` model:
 ```php
 <?php
 

config/request-analytics.php

@@ -9,6 +9,7 @@
     'capture' => [
         'web' => true,
         'api' => true,
+        'bots' => false, // Set to true to capture bot traffic
     ],
 
     'queue' => [
@@ -23,4 +24,15 @@
         'enabled' => env('REQUEST_ANALYTICS_PRUNING_ENABLED', true),
         'days' => env('REQUEST_ANALYTICS_PRUNING_DAYS', 90),
     ],
+
+    'geolocation' => [
+        'enabled' => env('REQUEST_ANALYTICS_GEO_ENABLED', true),
+        'provider' => env('REQUEST_ANALYTICS_GEO_PROVIDER', 'ipapi'), // ipapi, ipgeolocation, maxmind
+        'api_key' => env('REQUEST_ANALYTICS_GEO_API_KEY'),
+    ],
+
+    'privacy' => [
+        'anonymize_ip' => env('REQUEST_ANALYTICS_ANONYMIZE_IP', false),
+        'respect_dnt' => env('REQUEST_ANALYTICS_RESPECT_DNT', true), // Respect Do Not Track header
+    ],
 ];

database/migrations/add_indexes_to_request_analytics_table.php.stub

@@ -0,0 +1,40 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        Schema::table('request_analytics', function (Blueprint $table) {
+            $table->index('visited_at');
+            $table->index('session_id');
+            $table->index('path');
+            $table->index('user_id');
+            $table->index('request_category');
+            $table->index(['visited_at', 'session_id']);
+            $table->index(['path', 'visited_at']);
+            $table->index(['browser', 'visited_at']);
+            $table->index(['operating_system', 'visited_at']);
+            $table->index(['country', 'visited_at']);
+        });
+    }
+
+    public function down()
+    {
+        Schema::table('request_analytics', function (Blueprint $table) {
+            $table->dropIndex(['visited_at']);
+            $table->dropIndex(['session_id']);
+            $table->dropIndex(['path']);
+            $table->dropIndex(['user_id']);
+            $table->dropIndex(['request_category']);
+            $table->dropIndex(['visited_at', 'session_id']);
+            $table->dropIndex(['path', 'visited_at']);
+            $table->dropIndex(['browser', 'visited_at']);
+            $table->dropIndex(['operating_system', 'visited_at']);
+            $table->dropIndex(['country', 'visited_at']);
+        });
+    }
+};

database/migrations/create_request_analytics_table.php.stub

@@ -23,6 +23,7 @@ return new class extends Migration
             $table->string('language')->nullable();
             $table->tinyText('query_params')->nullable();
             $table->string('session_id');
+            $table->string('visitor_id')->nullable()->index();
             $table->foreignId('user_id')->nullable()->constrained();
             $table->string('http_method');
             $table->string('request_category');

routes/web.php

@@ -2,14 +2,18 @@
 
 use Illuminate\Support\Facades\Route;
 use MeShaon\RequestAnalytics\Controllers\RequestAnalyticsController;
+use MeShaon\RequestAnalytics\Controllers\Api\AnalyticsApiController;
 
 Route::middleware(['web', 'auth', 'request-analytics.access'])
     ->get(config('request-analytics.route.pathname'), [RequestAnalyticsController::class, 'show'])
     ->name(config('request-analytics.route.name'));
 
 Route::middleware(['api', 'auth:sanctum', 'request-analytics.access'])
-    ->get('api/v1'.config('request-analytics.route.pathname'), function () {
-        return response()->json([
-            'data' => 'Coming soon...',
-        ]);
-    })->name(config('request-analytics.route.name').'.api');
+    ->prefix('api/v1/analytics')
+    ->name('request-analytics.api.')
+    ->group(function () {
+        Route::get('/overview', [AnalyticsApiController::class, 'overview'])->name('overview');
+        Route::get('/visitors', [AnalyticsApiController::class, 'visitors'])->name('visitors');
+        Route::get('/page-views', [AnalyticsApiController::class, 'pageViews'])->name('page-views');
+        Route::post('/export', [AnalyticsApiController::class, 'export'])->name('export');
+    });