laravel plausible Download - laravel plausible Source code download

laravel plausible

Other source code

1.2.0

Download

Laravel Plausible

A simple package for communicating with the Plausible API within Laravel.

Installation

You can install the package via composer:

composer require kilobyteno/laravel-plausible

You can publish the config file with:

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

This is the contents of the published config file:

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

Usage

use KilobytenoLaravelPlausiblePlausible;

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

Catching exceptions

use KilobytenoLaravelPlausibleExceptionsPlausibleAPIException;

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