Piwik-PHP-API: A PHP repository from axelcho

Piwiki PHP API

A PHP wrapper class for the Piwik API.

Requirements

PHP >= 5.4
cUrl (php-curl)

Install

This library can be installed via composer: "visualappeal/piwik-php-api": "1.2.*"

Changelog

1.2.1 (2015/11/09)

Added: Compatible to Piwik 2.15.1

1.2.0 (2015/05/03)

Changed: Removed optional parameters for the methods and added optional parameters array. Some methods signatures changed, so please check your methods before upgrading.

For example getUrlsForSocial($segment = '', $idSubtable = '') is now getUrlsForSocial($segment = '', $optional = []). So instead of calling $piwik->getUrlsForSocial('browserCode==FF;country==DE', 4) you have to call $piwik->getUrlsForSocial('browserCode==FF;country==DE', ['idSubtable' => 4]).

Added: Compatible to Piwik 2.13.0

1.1.2 (2015/03/22)

Fixed: Errors were not appended to error array
Changed: Requires PHP 5.4 (5.3 is not supported anymore)
Added: Unit tests

1.1.1 (2015/02/18)

Added: Get separate data entries for a date range without the range period parameter #14
Added: Compatible to Piwik 2.11

1.1.0 (2015/02/13)

Changed: Support for PSR-4 autoloading

1.0.1 (2015/02/13)

Fixed: Multiple bugs

1.0.0 (2014/12/13)

Added: Compatibility to piwik 2.10.0

Usage

Create an instance of piwik

require(__DIR__ . '/vendor/autoload.php');

use VisualAppeal\Piwik;

$piwik = new Piwik('http://stats.example.org', 'my_access_token', 'siteId');

There are some basic parameters (period, date, range) which you can define at the beginning. They do not change until you reset them with

$piwik->reset();

So you can execute multiple requests without specifying the parameters again.

siteId

The ID of your website, single number, list separated through comma "1,4,7", or "all"

period

The period you request the statistics for

Piwik::PERIOD_DAY
Piwik::PERIOD_WEEK
Piwik::PERIOD_MONTH
Piwik::PERIOD_YEAR
Piwik::PERIOD_RANGE

If you set the period to Piwik::PERIOD_RANGE you can specify the range via

$piwik->setRange('2012-01-14', '2012-04-30'); //All data from the first to the last date
$piwik->setRange('2012-01-14', Piwik::DATE_YESTERDAY); //All data from the first until yesterday
$piwik->setRange('2012-01-14'); //All data from the first until now

When you use the period range you do not need to specify a date!

If you set it to something other than Piwik::PERIOD_RANGE you can specify the date via

$piwik->setPeriod(x);
$piwik->setDate('2012-03-03');

Case x of PERIOD_DAY the report is created for the third of march, 2012
Case x of PERIOD_WEEK the report is created for the first week of march, 2012
Case x of PERIOD_MONTH the report is created for march, 2012
Case x of PERIOD_YEAR the report is created for 2012

date

Set the date via

$piwik->setDate('YYYY-mm-dd');

Or use the constants

$piwik->setDate(Piwik::DATE_TODAY);
$piwik->setDate(Piwik::DATE_YESTERDAY);

Report for the last seven weeks including the current week

$piwik->setPeriod(Piwik::PERIOD_WEEK);
$piwik->setDate('last7');

Report for the last 2 years without the current year

$piwik->setPeriod(Piwik::PERIOD_YEAR);
$piwik->setDate('previous2');

segment, idSubtable, expanded

For some functions you can specify segment, idSubtable and expanded. Please refer to the piwik segment documentation and to the api reference for more information about these parameters.

format

Specify a output format via

$piwik->setFormat(Piwik::FORMAT_JSON);

JSON is converted with json_decode before returning the request.

All available formats

Piwik::FORMAT_XML
Piwik::FORMAT_JSON
Piwik::FORMAT_CSV
Piwik::FORMAT_TSV
Piwik::FORMAT_HTML
Piwik::FORMAT_RSS
Piwik::FORMAT_PHP

Example

Get all the unique visitors from yesterday:

require(__DIR__ . '/vendor/autoload.php');

use VisualAppeal\Piwik;

$piwik = new Piwik('http://stats.example.org', 'my_access_token', 1, Piwik::FORMAT_JSON);

$piwik->setPeriod(Piwik::PERIOD_DAY);
$piwik->setDate(Piwik::DATE_YESTERDAY);

echo 'Unique visitors yesterday: ' . $piwik->getUniqueVisitors();

axelcho/Piwik-PHP-API