Skip to main content

Loading Data from Qualtrics to Azure Synapse using dlt in Python

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 Violetta.

Qualtrics is a cloud-based survey platform that allows users to build surveys, distribute them, and analyze the results. Azure Synapse is a limitless analytics service that combines enterprise data warehousing and Big Data analytics. This documentation provides guidance on loading data from Qualtrics to Azure Synapse using the open-source Python library dlt. The dlt library facilitates seamless data extraction, transformation, and loading processes, ensuring efficient data handling and integration between Qualtrics and Azure Synapse. For further information on Qualtrics, visit their website.

dlt Key Features​

  • Pipeline Metadata: dlt pipelines leverage metadata to provide governance capabilities. This metadata includes load IDs, which consist of a timestamp and pipeline name. Load IDs enable incremental transformations and data vaulting by tracking data loads and facilitating data lineage and traceability. Read more about lineage.
  • Schema Enforcement and Curation: dlt empowers users to enforce and curate schemas, ensuring data consistency and quality. Schemas define the structure of normalized data and guide the processing and loading of data. By adhering to predefined schemas, pipelines maintain data integrity and facilitate standardized data handling practices. Read more: Adjust a schema docs.
  • Scalability via Iterators, Chunking, and Parallelization: dlt offers scalable data extraction by leveraging iterators, chunking, and parallelization techniques. This approach allows for efficient processing of large datasets by breaking them down into manageable chunks. Read more about performance.
  • Implicit Extraction DAGs: dlt incorporates the concept of implicit extraction DAGs to handle the dependencies between data sources and their transformations automatically. This extraction DAG determines the optimal order for extracting the resources to ensure data consistency and integrity. Read more about building a pipeline tutorial.
  • Verified Sources: dlt provides verified sources like Matomo, Asana, and others to help you quickly set up data pipelines with popular data sources. For example, Matomo is a free and open-source web analytics platform that provides detailed insights into website and application performance. Read more about Matomo.

Getting started with your pipeline locally​

OpenAPI Source Generator dlt-init-openapi

This walkthrough makes use of the dlt-init-openapi generator cli tool. You can read more about it here. The code generated by this tool uses the dlt rest_api verified source, docs for this are here.

0. Prerequisites​

dlt and dlt-init-openapi requires Python 3.9 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 and dlt-init-openapi​

First you need to install the dlt-init-openapi cli tool.

pip install dlt-init-openapi

The dlt-init-openapi cli is a powerful generator which you can use to turn any OpenAPI spec into a dlt source to ingest data from that api. The quality of the generator source is dependent on how well the API is designed and how accurate the OpenAPI spec you are using is. You may need to make tweaks to the generated code, you can learn more about this here.

# generate pipeline
# NOTE: add_limit adds a global limit, you can remove this later
# NOTE: you will need to select which endpoints to render, you 
# can just hit Enter and all will be rendered.
dlt-init-openapi qualtrics --url https://raw.githubusercontent.com/dlt-hub/openapi-specs/main/open_api_specs/Business/qualtrics.yaml --global-limit 2
cd qualtrics_pipeline
# install generated requirements
pip install -r requirements.txt

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

dlt>=0.4.12

You now have the following folder structure in your project:

qualtrics_pipeline/
├── .dlt/
│   ├── config.toml          # configs for your pipeline
│   └── secrets.toml         # secrets for your pipeline
├── rest_api/                # The rest api verified source
│   └── ...
├── qualtrics/                
│   └── __init__.py          # TODO: possibly tweak this file
├── qualtrics_pipeline.py        # your main pipeline script
├── requirements.txt         # dependencies for your pipeline
└── .gitignore               # ignore files for git (not required)

1.1. Tweak qualtrics/__init__.py​

This file contains the generated configuration of your rest_api. You can continue with the next steps and leave it as is, but you might want to come back here and make adjustments if you need your rest_api source set up in a different way. The generated file for the qualtrics source will look like this:

Click to view full file (97 lines)

from typing import List

import dlt
from dlt.extract.source import DltResource
from rest_api import rest_api_source
from rest_api.typing import RESTAPIConfig


@dlt.source(name="qualtrics_source", max_table_nesting=2)
def qualtrics_source(
        api_key: str = dlt.secrets.value,
        base_url: str = dlt.config.value,
) -> List[DltResource]:

    # source configuration
    source_config: RESTAPIConfig = {
        "client": {
            "base_url": base_url,
            "auth": {
                
            "type": "api_key",
            "api_key": api_key,
            "name": "X-API-TOKEN",
            "location": "header"

            },
        },
        "resources": 
        [
        # Gets all distributions for a given survey
        {
            "name": "distribution",
            "table_name": "distribution",
            "primary_key": "id",
            "write_disposition": "merge",
            "endpoint": {
                "data_selector": "result.elements",
                "path": "/distributions",
                "params": {
                    "surveyId": "FILL_ME_IN", # TODO: fill in required query parameter

                },
                "paginator": "auto",
            }
        },
        # Get event subscriptions
        {
            "name": "event_subscriptions_response",
            "table_name": "event_subscriptions_response",
            "endpoint": {
                "data_selector": "$",
                "path": "/eventsubscriptions/{SubscriptionId}",
                "params": {
                    "SubscriptionId": "FILL_ME_IN", # TODO: fill in required path parameter

                },
                "paginator": "auto",
            }
        },
        # Retrieves all the individual links for a given distribution
        {
            "name": "link",
            "table_name": "link",
            "endpoint": {
                "data_selector": "result.elements",
                "path": "/distributions/{DistributionId}/links",
                "params": {
                    "DistributionId": {
                        "type": "resolve",
                        "resource": "distribution",
                        "field": "id",
                    },
                    "surveyId": "FILL_ME_IN", # TODO: fill in required query parameter

                },
                "paginator": "auto",
            }
        },
        # Gets a single Qualtrics survey speficied by its ID
        {
            "name": "survey_response",
            "table_name": "survey_response",
            "endpoint": {
                "data_selector": "$",
                "path": "/survey-definitions/{SurveyId}",
                "params": {
                    "SurveyId": "FILL_ME_IN", # TODO: fill in required path parameter

                },
                "paginator": "auto",
            }
        },
        ]
    }

    return rest_api_source(source_config)

2. Configuring your source and destination credentials​

info

dlt-init-openapi will try to detect which authentication mechanism (if any) is used by the API in question and add a placeholder in your secrets.toml.

  • If you know your API needs authentication, but none was detected, you can learn more about adding authentication to the rest_api here.
  • OAuth detection currently is not supported, but you can supply your own authentication mechanism as outlined here.

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. The automatically created version of these files look like this:

generated config.toml​


[runtime]
log_level="INFO"

[sources.qualtrics]
# Base URL for the API
base_url = "https://fra1.qualtrics.com/API/v3"

generated secrets.toml​


[sources.qualtrics]
# secrets for your qualtrics source
api_key = "FILL ME OUT"  # TODO: fill in your credentials

2.1. Adjust the generated code to your usecase​

Further help setting up your source and destinations

At this time, the dlt-init-openapi cli tool will always create pipelines that load to a local duckdb instance. Switching to a different destination is trivial, all you need to do is change the destination parameter in qualtrics_pipeline.py to synapse and supply the credentials as outlined in the destination doc linked below.

  • Read more about setting up the rest_api source in our docs.
  • Read more about setting up the Azure Synapse destination in our docs.

3. Running your pipeline for the first time​

The dlt cli has also created a main pipeline script for you at qualtrics_pipeline.py, as well as a folder qualtrics 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:


import dlt

from qualtrics import qualtrics_source


if __name__ == "__main__":
    pipeline = dlt.pipeline(
        pipeline_name="qualtrics_pipeline",
        destination='duckdb',
        dataset_name="qualtrics_data",
        progress="log",
        export_schema_path="schemas/export"
    )
    source = qualtrics_source()
    info = pipeline.run(source)
    print(info)

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

python qualtrics_pipeline.py

4. Inspecting your load result​

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

dlt pipeline qualtrics_pipeline     info

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

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline qualtrics_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: Learn how to deploy a pipeline using GitHub Actions, a CI/CD runner that you can use for free. Follow the guide here.
  • Deploy with Airflow and Google Composer: This guide shows you how to deploy a pipeline with Airflow and Google Composer, a managed Airflow environment provided by Google. Read more here.
  • Deploy with Google Cloud Functions: Find out how to deploy a pipeline using Google Cloud Functions, a serverless execution environment for building and connecting cloud services. Explore the guide here.
  • Other Deployment Options: Discover various other methods to deploy your pipeline, including using different cloud services and platforms. Check out the comprehensive guide here.

The running in production section will teach you about:​

  • How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline in production to ensure smooth operation and quick identification of issues. Read more
  • Set up alerts: Set up alerts to get notified about any issues or important events in your dlt pipeline, ensuring you can act swiftly to maintain data flow. Read more
  • Set up tracing: Implement tracing in your dlt pipeline to get detailed insights into the execution and performance of your data processes. Read more

Available Sources and Resources​

For this verified source the following sources and resources are available

Source Qualtrics​

Collects survey responses, distribution data, and event subscription details from Qualtrics.

Resource NameWrite DispositionDescription
distributionappendDetails about the distribution of surveys to respondents
linkappendInformation about the links generated for survey distribution
survey_responseappendResponses collected from the distributed surveys
event_subscriptions_responseappendData related to event subscriptions and their responses

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.