Querying the Reporting API

This guide explains how to call the Piwik API to request your web analytics data. There are two methods:

  • using the standard HTTP API
  • using Piwik's PHP code directly

Call the Piwik API using the HTTP API

If you want to request data in any language (PHP, Python, Ruby, ASP, C++, Java, etc.) you can use the HTTP API. It is a simple way to request data via an HTTP GET.

Security Notice

If the API call requires the token_auth and the HTTP request is sent over untrusted networks, we highly advise that you use an encrypted request. Otherwise, your token_auth is exposed to eavesdroppers. This can be done using https instead of http. In the following example, replace the string "http" by "https".

You can, for example, get the top 100 search engine keywords used to find your website during the current week. Here is an example in PHP:

<?php
exit; // REMOVE this line to run the script

// this token is used to authenticate your API request.
// You can get the token on the API page inside your Piwik interface
$token_auth = 'anonymous';

// we call the REST API and request the 100 first keywords for the last month for the idsite=7
$url = "http://demo.piwik.org/";
$url .= "?module=API&method=Referrers.getKeywords";
$url .= "&idSite=7&period=month&date=yesterday";
$url .= "&format=PHP&filter_limit=20";
$url .= "&token_auth=$token_auth";

$fetched = file_get_contents($url);
$content = unserialize($fetched);

// case error
if (!$content) {
    print("Error, content fetched = " . $fetched);
}

print("<h1>Keywords for the last month</h1>");
foreach ($content as $row) {
    $keyword = htmlspecialchars(html_entity_decode(urldecode($row['label']), ENT_QUOTES), ENT_QUOTES);
    $hits = $row['nb_visits'];

    print("<b>$keyword</b> ($hits hits)<br>");
}

Here is the output of this code:

<h1>Keywords for the last month</h1><b>Keyword not defined</b> (17298 hits)<br><b>xxxx</b> (24 hits)<br><b>premature end of data</b> (4 hits)<br><b>all websites</b> (3 hits)<br><b>http://forum.piwik.org/read.php?2,87124</b> (3 hits)<br><b>anschreiben auftragsdatenverarbeitung</b> (2 hits)<br><b>blackwik</b> (2 hits)<br><b>downloads anzeigen</b> (2 hits)<br><b>error: [$compile:tplrt]</b> (2 hits)<br><b>piwik add own user agent</b> (2 hits)<br><b>piwik architecture</b> (2 hits)<br><b>piwik deutsch</b> (2 hits)<br><b>piwik login</b> (2 hits)<br><b>piwik unique visitors</b> (2 hits)<br><b>trying to load data from a file in mysql and get access denied for user at localhost error</b> (2 hits)<br><b>uninstall piwik</b> (2 hits)<br><b>www.xxx.com</b> (2 hits)<br><b>xxxx.com</b> (2 hits)<br><b>xxxx.xxx</b> (2 hits)<br><b>&#1079;&#1080;&#1084;&#1085;&#1080; &#1087;&#1072;&#1083;&#1090;&#1072;</b> (2 hits)<br>

Call the Piwik API in PHP

If you want to request data in a PHP script that is on the same server as Piwik, you can use this simple technique. This is a more efficient solution as it doesn't require network calls. You directly call the PHP Piwik runtime and get the PHP data structure back.

If you are developing a plugin, you should be using this technique.

<?php
use Piwik\API\Request;
use Piwik\FrontController;

define('PIWIK_INCLUDE_PATH', realpath('../..'));
define('PIWIK_USER_PATH', realpath('../..'));
define('PIWIK_ENABLE_DISPATCH', false);
define('PIWIK_ENABLE_ERROR_HANDLER', false);
define('PIWIK_ENABLE_SESSION_START', false);

// if you prefer not to include 'index.php', you must also define here PIWIK_DOCUMENT_ROOT
// and include "libs/upgradephp/upgrade.php" and "core/Loader.php"
require_once PIWIK_INCLUDE_PATH . "/index.php";
require_once PIWIK_INCLUDE_PATH . "/core/API/Request.php";

FrontController::getInstance()->init();

// This inits the API Request with the specified parameters
$request = new Request('
			module=API
			&method=UserSettings.getResolution
			&idSite=7
			&date=yesterday
			&period=week
			&format=XML
			&filter_limit=3
			&token_auth=anonymous
');
// Calls the API and fetch XML data back
$result = $request->process();
echo $result;

Here is the output of this script:

<?xml version="1.0" encoding="utf-8" ?>
<result>
	<row>
		<label>1920x1080</label>
		<nb_visits>1515</nb_visits>
		<nb_actions>3233</nb_actions>
		<max_actions>54</max_actions>
		<sum_visit_length>205215</sum_visit_length>
		<bounce_count>1064</bounce_count>
		<nb_visits_converted>28</nb_visits_converted>
		<sum_daily_nb_uniq_visitors>1360</sum_daily_nb_uniq_visitors>
		<sum_daily_nb_users>0</sum_daily_nb_users>
	</row>
	<row>
		<label>1366x768</label>
		<nb_visits>1017</nb_visits>
		<nb_actions>2006</nb_actions>
		<max_actions>51</max_actions>
		<sum_visit_length>117325</sum_visit_length>
		<bounce_count>758</bounce_count>
		<nb_visits_converted>29</nb_visits_converted>
		<sum_daily_nb_uniq_visitors>919</sum_daily_nb_uniq_visitors>
		<sum_daily_nb_users>0</sum_daily_nb_users>
	</row>
	<row>
		<label>1680x1050</label>
		<nb_visits>510</nb_visits>
		<nb_actions>1148</nb_actions>
		<max_actions>34</max_actions>
		<sum_visit_length>88831</sum_visit_length>
		<bounce_count>319</bounce_count>
		<nb_visits_converted>9</nb_visits_converted>
		<sum_daily_nb_uniq_visitors>450</sum_daily_nb_uniq_visitors>
		<sum_daily_nb_users>0</sum_daily_nb_users>
	</row>
</result>