© saicle/Shutterstock.com
PHP Magazin
Maßgeschneiderte Webanalyse

Das Piwik-REST-API

Piwik ist die führende Open-Source-Alternative (GPLv3) zu Google Analytics. Die Webanalyseplattform, die auf PHP und MySQL basiert, können Sie vom Tracking-API [1] über Plug-ins [2] bis hin zum REST-API [3] an Ihre Bedürfnisse anpassen und auf einem eigenen Server installieren - und behalten dadurch die Kontrolle über alle aufgezeichneten Daten. Besonders interessant ist dabei Piwiks REST-API. Hierüber können Sie nicht nur alle vorhandenen Reporte nach Belieben abrufen, sondern die Software auch komplett verwalten. Es lassen sich sogar Funktionen wie Segmentierung [4] nutzen, die generell vorhanden, aber nicht in das Piwik-UI integriert sind. Lesen Sie in den folgenden Abschnitten, wie das API funktioniert und was Sie damit machen können.

Thomas Steur


Piwiks REST-API besteht aus über zwanzig Objekten, die insgesamt über zweihundert Methoden enthalten. Im Artikel sei daher nur auf einige wichtige davon eingegangen. Eine ergänzende Kurzdokumentation finden Sie in Ihrer Piwik-Installation über den Menüpunkt API (Abb. 1). Die vollständige Dokumentation liegt in der API-Referenz [3]. Sollten Ihnen diese Methoden nicht ausreichen, können Sie über Plug-ins weitere hinzufügen. Und wenn Sie Probleme beim Aufrufen des API haben, prüfen Sie in den Einstellungen von Piwik, ob einzelne Objekte oder sogar das gesamte API nicht versehentlich deaktiviert sind. Ein API-Aufruf muss neben der Angabe des Moduls API mindestens den Namen der gewünschten Methode enthalten. Das Standardformat ist XML. Beispiel: http://demo.piwik.org/?module=API&method=API.getPiwikVersion

1.9.3

Abb. 1: Der Menüpunkt zur API-Kurzdokumentation. Sie finden dort Ihren Auth-Token und können mit nur einem Klick alle Methoden ausprobieren

Authentifizierung

Standardmäßig ist Ihre Piwik-Installation nicht öffentlich. Die meisten API-Aufrufe benötigen daher eine Authentifizierung. Sie erfolgt über einen URL-Parameter namens token_auth. Ihren Auth-Token bekommen Sie entweder über den Menüpunkt API oder über das REST-API durch Aufrufen der Methode UsersManager.getTokenAuth. Die Methode erwartet als Parameter Ihren Benutzernamen sowie Ihr Passwort als MD5-Hash.

Achtung: Sobald Sie Ihr Passwort ändern, ändert sich auch Ihr Auth-Token (das Sie auch nicht weitergeben sollten, da andere Personen sich sonst darüber einloggen könnten). Es ist so geheim wie Ihr Benutzername und Passwort. Damit Ihr Auth-Token beim Verwenden des API nicht im Klartext übertragen wird, empfehle ich Ihnen, nach Möglichkeit ­HTTPS zu verwenden. API-Aufruf mit Authentifizierung: http://demo.piwik.org/?module=API&method=​API.getPiwikVersion&token_auth=​d41d8cd98f00b204e9800998ecf8427e.

Reportdaten abfragen

Sie haben über das API Zugriff auf alle Reporte, darunter Aktionen, benutzerdefinierte Variablen, Ziele, E-Commerce, Besucher, Referrer, Kampagnen, Suchmaschinen und Provider. Zum Abfragen der Statistiken stehen Ihnen einige Standardparameter zur Verfügung, die für die meisten Methoden Gültigkeit haben (Tabelle 1).

ParameterBeschreibung dateDas zu verwendende Datum, ein Datumsbereich oder Keywords wie today, yesterday, last5 oder previous42. Ein last5 gibt Ihnen die Statistiken der letzten fünf Einheiten zurück, previous42 die der vorherigen 42 Einheiten, wobei die heutige E...

PHP Magazin
Maßgeschneiderte Webanalyse

Das Piwik-REST-API

Piwik ist die führende Open-Source-Alternative (GPLv3) zu Google Analytics. Die Webanalyseplattform, die auf PHP und MySQL basiert, können Sie vom Tracking-API [1] über Plug-ins [2] bis hin zum REST-API [3] an Ihre Bedürfnisse anpassen und auf einem eigenen Server installieren - und behalten dadurch die Kontrolle über alle aufgezeichneten Daten. Besonders interessant ist dabei Piwiks REST-API. Hierüber können Sie nicht nur alle vorhandenen Reporte nach Belieben abrufen, sondern die Software auch komplett verwalten. Es lassen sich sogar Funktionen wie Segmentierung [4] nutzen, die generell vorhanden, aber nicht in das Piwik-UI integriert sind. Lesen Sie in den folgenden Abschnitten, wie das API funktioniert und was Sie damit machen können.

Thomas Steur


Piwiks REST-API besteht aus über zwanzig Objekten, die insgesamt über zweihundert Methoden enthalten. Im Artikel sei daher nur auf einige wichtige davon eingegangen. Eine ergänzende Kurzdokumentation finden Sie in Ihrer Piwik-Installation über den Menüpunkt API (Abb. 1). Die vollständige Dokumentation liegt in der API-Referenz [3]. Sollten Ihnen diese Methoden nicht ausreichen, können Sie über Plug-ins weitere hinzufügen. Und wenn Sie Probleme beim Aufrufen des API haben, prüfen Sie in den Einstellungen von Piwik, ob einzelne Objekte oder sogar das gesamte API nicht versehentlich deaktiviert sind. Ein API-Aufruf muss neben der Angabe des Moduls API mindestens den Namen der gewünschten Methode enthalten. Das Standardformat ist XML. Beispiel: http://demo.piwik.org/?module=API&method=API.getPiwikVersion

1.9.3

Abb. 1: Der Menüpunkt zur API-Kurzdokumentation. Sie finden dort Ihren Auth-Token und können mit nur einem Klick alle Methoden ausprobieren

Authentifizierung

Standardmäßig ist Ihre Piwik-Installation nicht öffentlich. Die meisten API-Aufrufe benötigen daher eine Authentifizierung. Sie erfolgt über einen URL-Parameter namens token_auth. Ihren Auth-Token bekommen Sie entweder über den Menüpunkt API oder über das REST-API durch Aufrufen der Methode UsersManager.getTokenAuth. Die Methode erwartet als Parameter Ihren Benutzernamen sowie Ihr Passwort als MD5-Hash.

Achtung: Sobald Sie Ihr Passwort ändern, ändert sich auch Ihr Auth-Token (das Sie auch nicht weitergeben sollten, da andere Personen sich sonst darüber einloggen könnten). Es ist so geheim wie Ihr Benutzername und Passwort. Damit Ihr Auth-Token beim Verwenden des API nicht im Klartext übertragen wird, empfehle ich Ihnen, nach Möglichkeit ­HTTPS zu verwenden. API-Aufruf mit Authentifizierung: http://demo.piwik.org/?module=API&method=​API.getPiwikVersion&token_auth=​d41d8cd98f00b204e9800998ecf8427e.

Reportdaten abfragen

Sie haben über das API Zugriff auf alle Reporte, darunter Aktionen, benutzerdefinierte Variablen, Ziele, E-Commerce, Besucher, Referrer, Kampagnen, Suchmaschinen und Provider. Zum Abfragen der Statistiken stehen Ihnen einige Standardparameter zur Verfügung, die für die meisten Methoden Gültigkeit haben (Tabelle 1).

ParameterBeschreibung dateDas zu verwendende Datum, ein Datumsbereich oder Keywords wie today, yesterday, last5 oder previous42. Ein last5 gibt Ihnen die Statistiken der letzten fünf Einheiten zurück, previous42 die der vorherigen 42 Einheiten, wobei die heutige E...

Neugierig geworden?


    
Loading...

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang