, (*1)
Analytics Statistics: Retrieve data from Google Analytics
, (*2)
An opinionated package to retrieve Google Analytics data. Compatible with PHP >= 5.3., (*3)
If you're using laravel 5, check out our laravel-analytics package!, (*4)
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., (*5)
Support us
, (*6)
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., (*7)
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., (*8)
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using., (*9)
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., (*10)
The best postcards will get published on the open source page on our website., (*11)
Install
This package can be installed through Composer., (*12)
``` bash
composer require spatie/analytics-statistics, (*13)
### How to obtain the credentials to communicate with Google Analytics
If you haven't already done so, [set up a Google Analytics property](https://support.google.com/analytics/answer/1042508) and [install the tracking code on your site](https://support.google.com/analytics/answer/1008080?hl=en#GA).
This package needs valid configuration values for `siteId`, `clientId` and `serviceEmail`. Additionally a `p12-file`is required.
To obtain these credentials start by going to the [Google Developers Console](https://console.developers.google.com).
If you don't have a project present in the console yet, create one.
If you click on the project name, you'll see a menu item `APIs` under `APIs & auth` on the left hand side. Click it to go the the Enabled API's screen. On that screen you should enable the Analytics API.
Now, again under the `APIs & Auth`-menu click `Credentials`.
On this screen you should press `Create new Client ID`. In the creation screen make sure you select application type `Service Account` and key type `P12-key`.
This wil generate a new public/private key pair and the .p12-file will get downloaded to your machine. Store this file in the location specified in the configfile of this package.
In the properties of the newly created Service Account you'll find the values for the `serviceEmail` and `clientId` listed as `CLIENT ID` and `EMAIL ADDRESS`.
To find the right value for `siteId` log in to [Google Analytics](http://www.google.be/intl/en/analytics/) go the the Admin section.
In the property-column select the website name of which you want to retrieve data, then click `View Settings` in the `View`-column.
The value presented as `View Id` prepended with 'ga:' can be used as `siteId`.
Make sure you've added the `ANALYTICS_SERVICE_EMAIL` to the Google Analytics Account otherwise you will get a `403: User does not have any Google Analytics Account` error. [You can read Google's instructions here](http://support.google.com/analytics/bin/answer.py?hl=en&answer=1009702).
If you want to use the realtime methods you should [request access](https://docs.google.com/forms/d/1qfRFysCikpgCMGqgF3yXdUyQW4xAlLyjKuOoOEFN2Uw/viewform) to the beta version of [Google's Real Time Reporting API](https://developers.google.com/analytics/devguides/reporting/realtime/v3/).
## Usage
### Setup
The easiest way to set up Analytics is via the factory method `\Spatie\Analytics\Analytics::create()`. The `create` method requires the following parameters:
```php
/**
* @param string $siteId
* @param string $clientId
* @param string $serviceEmail
* @param string $certificatePath
*/
You can optionally add some extra parameters to set up caching:, (*14)
/**
* @param \Spatie\Analytics\Cache $cache
* @param int $cacheLifetimeInMinutes
* @param int $realTimeCacheLifetime
*/
Note: If you want to use a cache, you'll need to write your own implementation/adapter using the \Spatie\Analytics\Analytics\Cache interface., (*15)
Example
use Spatie\Analytics\Analytics;
$analytics = Analytics::create(
'ga:xxxxxxxx',
'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com',
'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@developer.gserviceaccount.com',
'/keys/analytics/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-privatekey.p12',
$myCache,
60 * 24 * 2,
5
);
When the setup is done you can easily retrieve Analytics data. Methods generally return a plain array., (*16)
Here is an example to retrieve visitors and pageview data for the last seven days., (*17)
/*
* $analyticsData now contains an array with 3 columns: "date", "visitors" and "pageViews"
*/
$analyticsData = $analytics->getVisitorsAndPageViews(7);
Here's another example to get the 20 most visited pages of the last 365 days, (*18)
/*
* $analyticsData now contains an array with 2 columns: "url" and "pageViews"
*/
$analyticsData = $analytics->getMostVisitedPages(365, 20);
Provided methods
Visitors and pageviews
These methods return an array with columns "date", "vistors" and "pageViews". When grouping by yearMonth, the first column will be called "yearMonth"., (*19)
/**
* Get the amount of visitors and pageviews
*
* @param int $numberOfDays
* @param string $groupBy Possible values: date, yearMonth
* @return array
*/
public function getVisitorsAndPageViews($numberOfDays = 365, $groupBy = 'date')
/**
* Get the amount of visitors and pageviews for the given period
*
* @param \DateTime $startDate
* @param \DateTime $endDate
* @param string $groupBy Possible values: date, yearMonth
* @return array
*/
public function getVisitorsAndPageViewsForPeriod($startDate, $endDate, $groupBy = 'date')
Keywords
These methods return an array with columns "keyword" and "sessions"., (*20)
/**
* Get the top keywords
*
* @param int $numberOfDays
* @param int $maxResults
* @return array
*/
public function getTopKeywords($numberOfDays = 365, $maxResults = 30)
/**
* Get the top keywords for the given period
*
* @param \DateTime $startDate
* @param \DateTime $endDate
* @param int $maxResults
* @return array
*/
public function getTopKeyWordsForPeriod($startDate, $endDate, $maxResults = 30)
Referrers
These methods return an array with columns "url" and "pageViews"., (*21)
/**
* Get the top referrers
*
* @param int $numberOfDays
* @param int $maxResults
* @return array
*/
public function getTopReferrers($numberOfDays = 365, $maxResults = 20)
/**
* Get the top referrers for the given period
*
* @param \DateTime $startDate
* @param \DateTime $endDate
* @param $maxResults
* @return array
*/
public function getTopReferrersForPeriod($startDate, $endDate, $maxResults)
Browsers
These methods return an array with columns "browser" and "sessions"., (*22)
If there are more used browsers than the number specified in maxResults, then a new resultrow with browser-name "other" will be appended with a sum of all the remaining browsers., (*23)
/**
* Get the top browsers
*
* @param int $numberOfDays
* @param int $maxResults
* @return array
*/
public function getTopBrowsers($numberOfDays = 365, $maxResults = 6)
/**
* Get the top browsers for the given period
*
* @param \DateTime $startDate
* @param \DateTime $endDate
* @param $maxResults
* @return array
*/
public function getTopBrowsersForPeriod($startDate, $endDate, $maxResults)
Most visited pages
These methods return an array with columns "url" and "pageViews"., (*24)
/**
* Get the most visited pages
*
* @param int $numberOfDays
* @param int $maxResults
* @return array
*/
public function getMostVisitedPages($numberOfDays = 365, $maxResults = 20)
/**
* Get the most visited pages for the given period
*
* @param \DateTime $startDate
* @param \DateTime $endDate
* @param int $maxResults
* @return array
*/
public function getMostVisitedPagesForPeriod($startDate, $endDate, $maxResults = 20)
Currently active visitors
This method uses the Real Time Reporting API. It returns the amount of visitors that is viewing your site
right now., (*25)
/**
* Get the number of active users currently on the site
*
* @param array $others
* @return array
*/
public function getActiveUsers($others = array())
All other Google Analytics Queries
To perform all other GA queries use performQuery. Google's Core Reporting API provides more information on on which metrics and dimensions might be used., (*26)
/**
* Call the query method on the autenthicated client
*
* @param \DateTime $startDate
* @param \DateTime $endDate
* @param $metrics
* @param array $others
* @return mixed
*/
public function performQuery($startDate, $endDate, $metrics, $others = array())
Testing
Run the tests with:, (*27)
vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details., (*28)
Security
If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., (*29)
Credits
About Spatie
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., (*30)
License
The MIT License (MIT). Please see License File for more information., (*31)
Wallogit.com
