laravel plausible

Laravelはもっともらしい

Laravel内のもっともらしいAPIと通信するための簡単なパッケージ。

インストール

Composer経由でパッケージをインストールできます。

composer require kilobyteno/laravel-plausible

構成ファイルを次のように公開できます。

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

これは、公開されている構成ファイルの内容です。

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

使用法

 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',
];
*/

例外をキャッチします

 use Kilobyteno  LaravelPlausible  Exceptions  PlausibleAPIException ;

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

テスト

composer test 

Changelog

最近変更されたものの詳細については、Changelogをご覧ください。

貢献

詳細については、寄付をご覧ください。

セキュリティの脆弱性

セキュリティの脆弱性を報告する方法についてのセキュリティポリシーを確認してください。

クレジット

• kilobyte as
• すべての貢献者

ライセンス

MITライセンス（MIT）。詳細については、ライセンスファイルをご覧ください。