PHP code example of tallesairan / laravel-plausible

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

tallesairan / laravel-plausible example snippets

use Airan\Plausible\Facades\Plausible;

Plausible::setBaseUrl('https://your-self-hosted-address.io');
Plausible::setSiteId('newera.com');
Plausible::setApiKey('eg-nw88131238128jj9213u1h3h1hh13h2h31200x1h5hh5')
/**
* Practical example
*/
# Let's assume that the Site Model has a belongs to many relationship with a model called Plausible

$sites = Site:with('plausible')->get();

foreach ($sites as $site){
    Plausible::setBaseUrl($site->plausible->base_url); // eg https://stats.newera.com
    Plausible::setApiKey($site->plausible->api_key); // set default api key
    Plausible::setSiteId($site->plausible_slug); // eg newera.com 
    
    $visitors = Plausible::realtime();
    $aggregates = Plausible::aggregates();
    ...
    
}

use Airan\Plausible\Facades\Plausible;

$visitors = Plausible::realtime();

use Airan\Plausible\Facades\Plausible;

$all = Plausible::aggregates();

use Airan\Plausible\Facades\Plausible;

// Simple with default
$aggregates = Plausible::aggregates();

// Or with optional custom parameters
$aggregates = Plausible::aggregates(
        period: 'custom',
        metrics: ['visitors', 'visits', 'pageviews'],
        filters: ['event:page==/blog**', 'visit:country==KE'],
        date: '2023-01-01,2023-01-31'
    );

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::aggregates(period: '7d')

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::aggregates(metrics: ['visitors', 'visits'])

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::aggregates(compare: false )

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::aggregates(filters: ['event:page==/blog**', 'visit:country==KE|DE'])

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::aggregates(period: 'custom', date: '2023-01-01,2023-01-31')

use Airan\Plausible\Facades\Plausible;

// Simple with default
$aggregates = Plausible::timeSeries();

// Or with optional custom parameters
$aggregates = Plausible::timeSeries(
        period: 'custom',
        metrics: ['visitors', 'visits', 'pageviews', 'views_per_visit', 'bounce_rate', 'visit_duration'],
        filters: ['event:page==/blog**'],
        interval: 'month',
        date: '2023-01-01,2023-01-31'
    );

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::timeSeries(period: '6mo')

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::timeSeries(metrics: ['visits', 'pageviews', 'views_per_visit'])

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::timeSeries(filters: ['event:page==/blog**', 'visit:browser==Firefox'])

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::timeSeries(interval: 'month')

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::timeSeries(period: 'custom', date: '2023-01-01,2023-01-31')

use \Airan\Plausible\Facades\Plausible;

// Simple with defaults
$visitors = Plausible::breakdown();

// With optional parameters
$aggregates = Plausible::breakdown(
        property: 'event:page',
        period: '12mo',
        metrics: ['visitors', 'visits', 'pageviews'],
        filters: 'event:page==/blog**',
        limit: 500
    );

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::breakdown(property: '6mo')

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::breakdown(period: '6mo')

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::breakdown(date: '2023-01-01')

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::breakdown(metrics: ['visits', 'pageviews', 'views_per_visit'])

use Airan\Plausible\Facades\Plausible;;

$aggregates = Plausible::breakdown(limit: 200)

use Airan\Plausible\Facades\Plausible;;

$aggregates = Plausible::breakdown(page: 2)

use Airan\Plausible\Facades\Plausible;

$aggregates = Plausible::breakdown(filters: 'event:page==/blog**')

bash
  php artisan plausible:install

json
[
    {
        "bounce_rate": 17,
        "date": "2023-01-01",
        "pageviews": 60,
        "views_per_visit": 19,
        "visit_duration": 525,
        "visitors": 6,
        "visits": 6
    },
    {
        "bounce_rate": 12,
        "date": "2023-01-02",
        "pageviews": 22,
        "views_per_visit": 4,
        "visit_duration": 149,
        "visitors": 6,
        "visits": 8
    },
    {
        "bounce_rate": 57,
        "date": "2023-01-03",
        "pageviews": 9,
        "views_per_visit": 2.57,
        "visit_duration": 48,
        "visitors": 7,
        "visits": 7
    },
    {
        "bounce_rate": 71,
        "date": "2023-01-04",
        "pageviews": 48,
        "views_per_visit": 8.43,
        "visit_duration": 301,
        "visitors": 7,
        "visits": 7
    }
]

json
[
    {
        "bounce_rate": 71,
        "page": "/",
        "pageviews": 146,
        "visit_duration": 126,
        "visitors": 87,
        "visits": 77
    },
    {
        "bounce_rate": 54,
        "page": "/articles",
        "pageviews": 179,
        "visit_duration": 206,
        "visitors": 71,
        "visits": 50
    },
    {
        "bounce_rate": 81,
        "page": "/blog/about-laravel-plausible",
        "pageviews": 42,
        "visit_duration": 27,
        "visitors": 35,
        "visits": 37
    },
    {
        "bounce_rate": 52,
        "page": "/pricing",
        "pageviews": 72,
        "visit_duration": 147,
        "visitors": 31,
        "visits": 27
    },
    {
        "bounce_rate": 76,
        "page": "/aquatadas",
        "pageviews": 22,
        "visit_duration": 82,
        "visitors": 21,
        "visits": 21
    }
]