Plausible Analytics Python API Docs | dltHub

Build a Plausible Analytics-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Plausible is an easy-to-use, privacy-focused web analytics platform offering a RESTful Stats API to query historical and near-real-time aggregated website metrics. The REST API base URL is https://plausible.io/api/v2 and All requests require a Bearer token (Stats API key) in the Authorization header..

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 Plausible Analytics data in under 10 minutes.


What data can I load from Plausible Analytics?

Here are some of the endpoints you can load from Plausible Analytics:

ResourceEndpointMethodData selectorDescription
query/api/v2/queryPOSTresultsPrimary Stats API endpoint: accepts query JSON and returns aggregated metrics and dimensions (results array).
health/api/healthGETHealth/status endpoint (simple 200 OK).
v1_timeseries (legacy)/api/v1/stats/timeseriesGETresultsLegacy timeseries endpoint returning array in results.
v1_aggregate (legacy)/api/v1/stats/aggregateGETresultsLegacy aggregate endpoint returning a results object.
v1_breakdown (legacy)/api/v1/stats/breakdownGETresultsLegacy breakdown endpoint returning list in results.
v1_realtime_visitors (legacy)/api/v1/stats/realtime/visitorsGETLegacy realtime visitors endpoint returns a raw number in body.

How do I authenticate with the Plausible Analytics API?

Obtain a Stats API key in your Plausible account (API Keys → New API Key → Stats API). Include the key in requests using the HTTP header: Authorization: Bearer YOUR-KEY. Use Content-Type: application/json for POST query requests.

1. Get your credentials

  1. Log in to your Plausible account. 2) Open "API Keys" in the left-hand sidebar. 3) Click "New API Key" and choose "Stats API". 4) Save the generated key when it is shown (it is shown only once).

2. Add them to .dlt/secrets.toml

[sources.plausible_analytics_source] api_key = "your_stats_api_key_here"

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:

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

1. Install the dlt AI Workbench:

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:

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 Plausible Analytics 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:

python plausible_analytics_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline plausible_analytics_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 query and timeseries from the Plausible Analytics API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def plausible_analytics_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://plausible.io/api/v2", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "query", "endpoint": {"path": "api/v2/query", "data_selector": "results"}}, {"name": "timeseries", "endpoint": {"path": "api/v1/stats/timeseries", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="plausible_analytics_pipeline", destination="duckdb", dataset_name="plausible_analytics_data", ) load_info = pipeline.run(plausible_analytics_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):

import dlt data = dlt.pipeline("plausible_analytics_pipeline").dataset() sessions_df = data.query.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM plausible_analytics_data.query LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("plausible_analytics_pipeline").dataset() data.query.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 Plausible Analytics data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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


Troubleshooting

Authentication failures

If Authorization header is missing or invalid you'll get HTTP 401; ensure Authorization: Bearer YOUR-KEY and that the key was created as a Stats API key. API keys are shown only once when created — create a new key if lost.

Rate limiting

Default rate limit is 600 requests per hour for API keys. Exceeding the limit will result in rate limit responses — reduce request rate or contact Plausible to request higher capacity.

Pagination and large results

Use the pagination parameters (include.total_rows and pagination.limit/offset in v2 query, or page/limit in legacy endpoints) to page through large result sets; include.total_rows adds meta.total_rows to the response.

Imported data and metric quirks

Including imported data has limitations (use include.imports); some combinations of metrics, filters and dimensions may not include imported data and the response meta will contain imports_included, imports_skip_reason or imports_warning. Some metrics may slightly vary depending on requested metrics due to different back-end tables.

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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Plausible Analytics?

Request dlt skills, commands, AGENT.md files, and AI-native context.