Python SDK for Piwik

This is an unofficial Python REST API Wrapper for Piwik Pro. It only supports Python 3.8+ and uses type annotation for an improved development experience.

Documentation

Module	API	Link
Administration	Apps	Apps API
	Meta Sites	Meta Sites API
Analytics	Events	Events API
	Sessions	Sessions API
	Query	Query API
	Real-Time-Events	Real-Time-Events API
	Goals	Goals API
	Custom Dimensions	Custom Dimensions API
	Product Custom Dimensions	Product Custom Dimensions API
	System Annotations	System Annotations API
	User Annotations	User Annotations API

Installation

Pip

pip install piwik-python-sdk

Poetry

poetry add piwik-python-sdk

Get started

Initialize a Client directly

client = Client(
    client_id="<client-id>",
    client_secret="<client-secret>",
    url="https://<account>.piwik.pro",
    auth_url="https://<account>.piwik.pro/auth/token",
)

The client can also be configured by setting the following environment variables:

export PIWIK_CLIENT_SECRET="<client secret>"
export PIWIK_CLIENT_ID="<client id>"
export PIWIK_URL="https://<account>.piwik.pro"
export PIWIK_AUTH_URL="https://<account>.piwik.pro/auth/token"

Examples

Search for specific apps

from piwik import Client

client = Client()

page_of_apps = client.apps.list(search="DE", page=0, size=50)
print(page_of_apps)

More examples can be found here: examples