laravel plausible

Ларавел правдоподобный

Простой пакет для общения с правдоподобным API в Laravel.

Установка

Вы можете установить пакет через композитор:

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 для получения дополнительной информации о том, что изменилось в последнее время.

Внося

Пожалуйста, смотрите для получения подробной информации.

Уязвимости безопасности

Пожалуйста, просмотрите нашу политику безопасности о том, как сообщать о уязвимости безопасности.

Кредиты

• Килобит как
• Все участники

Лицензия

Лицензия MIT (MIT). Пожалуйста, смотрите файл лицензии для получения дополнительной информации.