Load Chartbeat data in Python using dltHub

In this guide, we'll set up a complete Chartbeat data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source
def chartbeat_historical_api_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.chartbeat.com/v2/",
            "auth": {
                "type": "apikey",
                "token": X-CB-AK,
            },
        },
        "resources": [
            "fetch", "status", "submit"
            ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='chartbeat_historical_api_pipeline',
        destination='duckdb',
        dataset_name='chartbeat_historical_api_data', 
    )
    # Load the data
    load_info = pipeline.run(chartbeat_historical_api_source())
    print(load_info) 

Why use dlt to generate Python pipelines?

• Accelerate pipeline development with AI-native context
• Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
• Build Python notebooks for end users of your data
• Low maintenance thanks to schema evolution with type inference, resilience and self-documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
• dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from Chartbeat's API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

• Fetch: Retrieve data related to traffic and metrics.
• Status: Check the current operational status of the API.
• Submit: Send data for processing and analysis.
• Tracking: Monitor real-time traffic data.
• Metrics: Access various metrics related to site performance.
• Filters: Apply filters to refine data queries.
• Dimensions: Explore different dimensions of data available.
• Recurring Queries: Manage and run recurring data queries.

You will then debug the Chartbeat pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡
Before getting started, set up a virtual environment (instructions) and install the dlt workspace:
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

Now you're ready to get started!

1. Install the dlt AI Workbench

   Configure the workbench for your coding assistant:

   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 about the dltHub AI Workbench and setup details for each assistant →

2. Install the rest-api-pipeline toolkit

   The AI Workbench provides different toolkits for each phase of the data engineering lifecycle. To start you need to install the rest-api-pipeline toolkit:

   Copy
   dlt ai toolkit rest-api-pipeline install

   This loads different skills and contexts about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. Importantly, it does not need to ask you for credentials directly. In dlt, API credentials are provided via a secrets.toml file (learn more about secrets management →), and the agent should use the MCP tools to see their shape and detect misconfigurations. It never needs to access the file directly.

   Learn more about the rest-api-pipeline toolkit →

3. Start LLM-assisted coding

   Here's a prompt to get you started:

   Prompt
   Copy
   Use /find-source to load data from the Chartbeat API into DuckDB.

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

4. View the result

   After the rest-api-pipeline workflow has finished, you will end up with a working REST API source with validated endpoints and a pipeline that writes data into a local dataset you have inspected and verified.

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

   By launching the Pipeline Dashboard, you can see various information about the pipeline and the loaded data

   • Pipeline overview: State, load metrics
   • Data's schema: tables, columns, types, hints
   • You can query the data itself

   Copy
   dlt pipeline chartbeat_historical_api_pipeline show

Running into errors?

There are several important considerations when using Chartbeat. One-time queries must be re-submitted for unique date ranges, and the domain variable must be set correctly to gather accurate traffic data. Additionally, JavaScript configuration variables are necessary for data visibility in dashboards. Clients in the EU can use a proxy to anonymize IP addresses, and it's crucial for first-party cookies to be enabled. Furthermore, certain features like headline and image testing only work with specific libraries, and there are limits on API requests to prevent throttling.

Next steps

You can go to the next phases of your data engineering journey by handing over to 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

Or explore the following resources for more information:

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset