عن المشروع
تعد Laravel Metrics Plausible مكتبة PHP تغلف واجهة برمجة تطبيقات Plausible Analytics Stats API v2، مما يوفر واجهة برمجية سلسة ومتوافقة مع Laravel لاسترجاع بيانات التحليلات وإدارتها.
الميزات الرئيسية:
- استرجاع الإجماليات (الزوار، مشاهدات الصفحات، معدل الارتداد، إلخ).
- الاستعلام عن بيانات السلاسل الزمنية مع نطاقات تاريخ وأبعاد مخصصة (ساعية، يومية، شهرية).
- الحصول على تفاصيل الصفحات، مصادر الزيارات، معايير UTM، الدول، المناطق، المدن، الأجهزة، المتصفحات، وأنظمة التشغيل.
- الوصول إلى تحويلات الأهداف، الأحداث المخصصة، وعدد الزوار اللحظي.
- إدارة مواقع وأهداف Plausible (عرض، إنشاء، حذف).
- بناء استعلامات مخصصة باستخدام منشئ استعلامات يحاكي حمولة API.
- التعامل مع المصادقة، حدود المعدل، وأخطاء API العامة مع استثناءات محددة.
- تعمل مع Plausible Cloud ونسخة المجتمع المستضافة ذاتياً.
- تخزين الإعدادات في قاعدة البيانات عبر spatie/laravel-settings، مما يلغي الحاجة لملفات الإعدادات.
التثبيت:
1. إضافة الحزمة: composer require jeffersongoncalves/laravel-metrics-plausible
2. تشغيل عمليات الترحيل لإنشاء جدول الإعدادات: php artisan migrate
الإعدادات:
بعد الترحيل، يتم تغذية الإعدادات من متغيرات البيئة:
PLAUSIBLE_API_KEY – مفتاح API من إعدادات Plausible.
PLAUSIBLE_SITE_ID – نطاق الموقع (مثل example.com).
PLAUSIBLE_BASE_URL – الرابط الأساسي لـ Plausible (الافتراضي https://plausible.io).
يمكن أيضاً تحديث الإعدادات برمجياً عبر فئة PlausibleSettings.
نظرة عامة على الاستخدام:
تتم جميع التفاعلات من خلال واجهة Plausible.
الإجماليات:
$stats = Plausible::aggregate();
$stats->visitors();
السلاسل الزمنية:
$rows = Plausible::timeseries(DateRange::Last30Days, Dimension::TimeDay);
الزوار اللحظيون:
$visitors = Plausible::realtimeVisitors();
الاستعلامات المخصصة:
يمكن استخدام Plausible::query() لبناء استعلامات معقدة باستخدام المقاييس والأبعاد والفلاتر.
إدارة المواقع والأهداف:
تتوفر طرق مثل Plausible::sites() و Plausible::createSite() و Plausible::goals() لإدارة الموارد بسهولة.
معالجة الأخطاء:
- AuthenticationException: عند فقدان أو عدم صحة مفتاح API.
- RateLimitException: عند تجاوز حدود الطلبات (HTTP 429).
- PlausibleException: للفشل العام في API.
الترخيص:
موزعة بموجب رخصة MIT.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.