Skip to main content

Python Data Loading from google analytics to motherduck with dlt

Need help deploying these pipelines, or figuring out how to run them in your data stack?

Join our Slack community or book a call with our support engineer Adrian.

This documentation provides a guide on using the open-source Python library dlt to load data from Google Analytics into MotherDuck. Google Analytics is a platform that gathers data from your websites and apps, generating reports to offer business insights. On the other hand, MotherDuck is a fast in-process analytical database, supporting a feature-rich SQL dialect along with deep integrations into client APIs. The dlt library is utilized to facilitate this data transfer. For more information about the source, visit Google Analytics.

dlt Key Features​

  • Easy to get started: dlt is a Python library that is easy to use and understand. Type pip install dlt and you're ready to go. Read more
  • Support for multiple data sources: dlt supports a wide variety of data sources, including APIs like Google Analytics and Matomo. Google Analytics Source | Matomo Source
  • Comprehensive tutorials: dlt provides detailed tutorials to guide users in building data pipelines, handling secrets, and creating reusable data sources. Follow the tutorial
  • Support for multiple destinations: dlt supports various destinations, including MotherDuck and DuckDB. MotherDuck Destination | DuckDB Destination
  • Integration with dbt: dlt integrates with dbt for data transformation, offering support for the DuckDB adapter. dbt Support

Getting started with your pipeline locally​

0. Prerequisites​

dlt requires Python 3.8 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.

1. Install dlt​

First you need to install the dlt library with the correct extras for MotherDuck:

pip install "dlt[motherduck]"

The dlt cli has a useful command to get you started with any combination of source and destination. For this example, we want to load data from Google Analytics to MotherDuck. You can run the following commands to create a starting point for loading data from Google Analytics to MotherDuck:

# create a new directory
mkdir my-google_analytics-pipeline
cd my-google_analytics-pipeline
# initialize a new pipeline with your source and destination
dlt init google_analytics motherduck
# install the required dependencies
pip install -r requirements.txt

The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:

google-analytics-data
google-api-python-client
google-auth-oauthlib
requests_oauthlib
dlt[motherduck]>=0.3.25

You now have the following folder structure in your project:

my-google_analytics-pipeline/
├── .dlt/
│   ├── config.toml          # configs for your pipeline
│   └── secrets.toml         # secrets for your pipeline
├── google_analytics/                   # folder with source specific files
│   └── ...
├── google_analytics_pipeline.py        # your main pipeline script
├── requirements.txt         # dependencies for your pipeline
└── .gitignore               # ignore files for git (not required)

2. Configuring your source and destination credentials​

The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline:

config.toml​

# put your configuration values here

[runtime]
log_level="WARNING"  # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see https://dlthub.com/docs/telemetry
dlthub_telemetry = true

[sources.google_analytics]
property_id = 0 # please set me up!
queries = 
["a", "b", "c"] # please set me up!

secrets.toml​

# put your secret values and credentials here. do not share this file and do not push it to github

[sources.google_analytics.credentials]
client_id = "client_id" # please set me up!
client_secret = "client_secret" # please set me up!
refresh_token = "refresh_token" # please set me up!
project_id = "project_id" # please set me up!

[destination.motherduck.credentials]
database = "database" # please set me up!
password = "password" # please set me up!
Further help setting up your source and destinations

Please consult the detailed setup instructions for the MotherDuck destination in the dlt destinations documentation.

Likewise you can find the setup instructions for Google Analytics source in the dlt verifed sources documentation.

3. Running your pipeline for the first time​

The dlt cli has also created a main pipeline script for you at google_analytics_pipeline.py, as well as a folder google_analytics that contains additional python files for your source. These files are your local copies which you can modify to fit your needs. In some cases you may find that you only need to do small changes to your pipelines or add some configurations, in other cases these files can serve as a working starting point for your code, but will need to be adjusted to do what you need them to do.

The main pipeline script will look something like this:

""" Loads the pipeline for Google Analytics V4. """

import time
from typing import Any

import dlt

from google_analytics import google_analytics

# this can also be filled in config.toml and be left empty as a parameter.
QUERIES = [
    {
        "resource_name": "sample_analytics_data1",
        "dimensions": ["browser", "city"],
        "metrics": ["totalUsers", "transactions"],
    },
    {
        "resource_name": "sample_analytics_data2",
        "dimensions": ["browser", "city", "dateHour"],
        "metrics": ["totalUsers"],
    },
]


def simple_load() -> Any:
    """
    Just loads the data normally. Incremental loading for this pipeline is on,
    the last load time is saved in dlt_state, and the next load of the pipeline will have the last load as a starting date.

    Returns:
        Load info on the pipeline that has been run.
    """
    # FULL PIPELINE RUN
    pipeline = dlt.pipeline(
        pipeline_name="dlt_google_analytics_pipeline",
        destination='motherduck',
        full_refresh=False,
        dataset_name="sample_analytics_data",
    )
    # Google Analytics source function - taking data from QUERIES defined locally instead of config
    # TODO: pass your google analytics property id as google_analytics(property_id=123,..)
    data_analytics = google_analytics(queries=QUERIES)
    info = pipeline.run(data=data_analytics)
    print(info)
    return info


def simple_load_config() -> Any:
    """
    Just loads the data normally. QUERIES are taken from config. Incremental loading for this pipeline is on,
    the last load time is saved in dlt_state, and the next load of the pipeline will have the last load as a starting date.

    Returns:
        Load info on the pipeline that has been run.
    """
    # FULL PIPELINE RUN
    pipeline = dlt.pipeline(
        pipeline_name="dlt_google_analytics_pipeline",
        destination='motherduck',
        full_refresh=False,
        dataset_name="sample_analytics_data",
    )
    # Google Analytics source function - taking data from QUERIES defined locally instead of config
    data_analytics = google_analytics()
    info = pipeline.run(data=data_analytics)
    print(info)
    return info


def chose_date_first_load(start_date: str = "2000-01-01") -> Any:
    """
    Chooses the starting date for the first pipeline load. Subsequent loads of the pipeline will be from the last loaded date.

    Args:
        start_date: The string version of the date in the format yyyy-mm-dd and some other values.
            More info: https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/DateRange

    Returns:
        Load info on the pipeline that has been run.
    """
    # FULL PIPELINE RUN
    pipeline = dlt.pipeline(
        pipeline_name="dlt_google_analytics_pipeline",
        destination='motherduck',
        full_refresh=False,
        dataset_name="sample_analytics_data",
    )
    # Google Analytics source function
    data_analytics = google_analytics(start_date=start_date)
    info = pipeline.run(data=data_analytics)
    print(info)
    return info


if __name__ == "__main__":
    start_time = time.time()
    simple_load()
    end_time = time.time()
    print(f"Time taken: {end_time-start_time}")

Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:

python google_analytics_pipeline.py

4. Inspecting your load result​

You can now inspect the state of your pipeline with the dlt cli:

dlt pipeline dlt_google_analytics_pipeline info

You can also use streamlit to inspect the contents of your MotherDuck destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline dlt_google_analytics_pipeline show

5. Next steps to get your pipeline running in production​

One of the beauties of dlt is, that we are just a plain Python library, so you can run your pipeline in any environment that supports Python >= 3.8. We have a couple of helpers and guides in our docs to get you there:

The Deploy section will show you how to deploy your pipeline to​

  • Deploy with Github Actions: dlt enables you to use Github Actions as a CI/CD runner for your pipeline deployments. This is a free and efficient way to automate your pipeline tasks.
  • Deploy with Airflow: You can deploy your dlt pipelines using Airflow, a robust workflow management system. dlt provides a simple Airflow wrapper to make this process easy.
  • Deploy with Google Cloud Functions: dlt supports deployment with Google Cloud Functions, allowing you to execute your pipelines in a serverless environment.
  • Other Deployment Options: In addition to the above, dlt provides several other deployment options to cater to various use cases and preferences.

The running in production section will teach you about:​

  • Monitor your pipeline: dlt provides tools to monitor your pipeline's performance and status. You can track the progress of your pipeline, check the status of each task, and get detailed information about any errors that occur. Check out the guide on how to monitor your pipeline for more information.
  • Set up alerts: With dlt, you can set up alerts to notify you of any issues with your pipeline. This can help you to quickly identify and resolve any problems, ensuring that your pipeline runs smoothly. Learn more about how to set up alerts.
  • Enable tracing: Tracing is a powerful tool that can help you to understand the behavior of your pipeline. With dlt, you can set up tracing to get detailed information about each step of your pipeline, helping you to identify any bottlenecks or issues. Find out more about setting up tracing.

Additional pipeline guides​

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.