laravel plausible

Laravel plausibel

Ein einfaches Paket zur Kommunikation mit der plausiblen API in Laravel.

Installation

Sie können das Paket über Komponist installieren:

composer require kilobyteno/laravel-plausible

Sie können die Konfigurationsdatei mit:

php artisan vendor:publish --tag= " plausible-config "

Dies ist der Inhalt der veröffentlichten Konfigurationsdatei:

 return [
    ' api_url ' => env ( ' PLAUSIBLE_API_URL ' , ' https://plausible.io/api/v1 ' ),
    ' api_key ' => env ( ' PLAUSIBLE_API_KEY ' , '' ),
];

Verwendung

 use Kilobyteno  LaravelPlausible  Plausible ;

// Show the stats for the default period (30d), the period is optional for all methods
$ visitors = Plausible:: getVisitors ( $ domain -> name );

// Show the stats for the last 12 months
$ pageviews = Plausible:: getPageviews ( $ domain -> name , ' 12mo ' );

// Get bounce rates for the last 7 days
$ bounceRate = Plausible:: getBounceRate ( $ domain -> name , ' 7d ' );

// Get visit duration for the last days
$ visitDuration = Plausible:: getVisitDuration ( $ domain -> name , ' day ' );

// Get realtime visitors
$ realtimeVisitors = Plausible:: getRealtimeVisitors ( $ domain -> name );

// Add a custom period and metrics
$ stats = Plausible:: get ( $ domain -> name , ' month ' , [ ' visitors ' , ' pageviews ' ]);

$ availablePeriods = Plausible:: getAllowedPeriods ();
// returns: ['12mo', '6mo', 'month', '30d', '7d', 'day']

$ allowedMetrics = Plausible:: getAllowedMetrics ();
// returns: ['visitors', 'pageviews', 'bounce_rate', 'visit_duration', 'visits', 'events']

$ allowedProperties = Plausible:: getAllowedProperties ();
/* 
returns [
    'event:name',
    'event:page',
    'visit:entry_page',
    'visit:exit_page',
    'visit:source',
    'visit:referrer',
    'visit:utm_medium',
    'visit:utm_source',
    'visit:utm_campaign',
    'visit:utm_content',
    'visit:utm_term',
    'visit:device',
    'visit:browser',
    'visit:browser_version',
    'visit:os',
    'visit:os_version',
    'visit:country',
];
*/

Ausnahmen fangen

 use Kilobyteno  LaravelPlausible  Exceptions  PlausibleAPIException ;

try {
    $ visitors = Plausible:: getVisitors ( $ domain -> name );
} catch ( PlausibleAPIException $ e ) {
    // Handle exception
}

Testen

composer test 

Changelog

Weitere Informationen zu dem, was sich in letzter Zeit geändert hat, finden Sie in ChangeLog.

Beitragen

Weitere Informationen finden Sie unter Beitrag.

Sicherheitslücken

Bitte überprüfen Sie unsere Sicherheitsrichtlinien, wie Sie Sicherheitslücken melden können.

Credits

• Kilobyte als
• Alle Mitwirkenden

Lizenz

Die MIT -Lizenz (MIT). Weitere Informationen finden Sie unter Lizenzdatei.