Piwik Pro Python API Docs | dltHub

Piwik Pro is an analytics platform that exposes data through a REST API. The REST API base URL is https://{account}.piwik.pro/api/ and All requests require a Bearer token obtained via OAuth2 client‑credentials..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Piwik Pro data in under 10 minutes.

---

What data can I load from Piwik Pro?

Here are some of the endpoints you can load from Piwik Pro:

---

How do I authenticate with the Piwik Pro API?

Obtain an OAuth2 access token via the /auth/token endpoint using client_credentials; include it as a Bearer token in the Authorization header of all API requests.

1. Get your credentials

1. Log in to your Piwik Pro account and navigate to Administration → API Credentials (or the equivalent OAuth client page).\n2. Create a new OAuth client (if none exists) and note the Client ID and Client Secret.\n3. Use the following cURL command, replacing <account-name>, <client-id> and <client-secret> with your values:\ncurl -X POST 'https://<account-name>.piwik.pro/auth/token' \ -H "Content-Type: application/json" \ --data '{ "grant_type": "client_credentials", "client_id": "<client-id>", "client_secret": "<client-secret>" }'\n4. The response contains access_token. Copy this token; it will be used as the Bearer token for all API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.piwik_pro_source]
token = "<your_bearer_token>"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Piwik Pro API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python piwik_pro_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline piwik_pro_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset piwik_pro_data
The duckdb destination used duckdb:/piwik_pro.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline piwik_pro_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads apps and analytics_query from the Piwik Pro API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def piwik_pro_source(client_id, client_secret=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{account}.piwik.pro/api/",
            "auth": {
                "type": "bearer",
                "token": client_id, client_secret,
            },
        },
        "resources": [
            {"name": "apps", "endpoint": {"path": "api/apps/v2"}},
            {"name": "analytics_query", "endpoint": {"path": "api/analytics/v1/query/"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="piwik_pro_pipeline",
        destination="duckdb",
        dataset_name="piwik_pro_data",
    )
    load_info = pipeline.run(piwik_pro_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("piwik_pro_pipeline").dataset()
sessions_df = data.apps.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM piwik_pro_data.apps LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("piwik_pro_pipeline").dataset()
data.apps.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Piwik Pro data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If the token request returns an error or the access_token is missing, verify that client_id and client_secret are correct and that the account has OAuth2 client permissions.

Token expiration

Tokens are valid for 1800 seconds (30 minutes). After expiration you must request a new token using the /auth/token endpoint.

Rate limiting / caching

All query results are cached for 10 minutes. Re‑issuing the same analytics query within this window returns a cached response; rapid repeated requests may be throttled.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack