Analytics - v1.0.0-beta1

Welcome to the ArtisanPack UI Analytics documentation. This package provides comprehensive, privacy-first analytics tracking for Laravel applications with multi-provider support, real-time dashboards, and GDPR-compliant consent management.

Table of Contents

• Getting Started

  • Quick Start Guide
  • Installation
  • Requirements
  • Configuration

• Usage

  • Usage Overview
  • Tracking Page Views
  • Tracking Events
  • Goals & Conversions
  • Date Ranges
  • Helper Functions

• Livewire Components

  • Components Overview
  • Analytics Dashboard
  • Stats Cards
  • Visitors Chart
  • Top Pages
  • Traffic Sources
  • Realtime Visitors

• API Reference

  • API Overview
  • Models
  • Services
  • Data Objects
  • Events
  • Contracts

• Advanced Topics

  • Advanced Overview
  • Multi-Tenancy
  • Privacy & Consent
  • Multiple Providers
  • Caching
  • Artisan Commands

• Help

  • FAQ
  • Troubleshooting

Features

• Privacy-First Design: GDPR-compliant with built-in consent management and IP anonymization
• Multi-Provider Support: Chain multiple analytics providers (Local, Google Analytics, Plausible)
• Real-Time Dashboard: Live visitor tracking with auto-updating widgets
• Multi-Tenancy: Support for multi-site and multi-tenant applications
• Livewire Components: Pre-built dashboard widgets with Chart.js integration
• Goal Tracking: Define and track conversions with URL, event, and engagement-based goals
• Session Management: Automatic session tracking with engagement metrics
• Blade Directives: Easy integration with @analyticsScripts and @analyticsConsent

Quick Example

{{-- Include the tracking script --}}
@analyticsScripts

{{-- Show consent banner if required --}}
@analyticsConsentBanner

{{-- Display the analytics dashboard --}}
<livewire:artisanpack-analytics::analytics-dashboard />

// Track a page view
trackPageView('/products', 'Products Page');

// Track a custom event
trackEvent('purchase', ['product_id' => 123], 99.99, 'ecommerce');

// Get analytics stats
$stats = analyticsStats(DateRange::last30Days());

Support

For issues and feature requests, please visit the GitLab repository.

License

ArtisanPack UI Analytics is open-sourced software licensed under the MIT license.