Klaviyo to Superset

This page provides you with instructions on how to extract data from Klaviyo and analyze it in Superset. (If the mechanics of extracting data from Klaviyo seem too complex or difficult to maintain, check out Stitch, which can do all the heavy lifting for you in just a few clicks.)

What is Klaviyo?

Klaviyo is an ecommerce marketing automation platform that lets organizations run data-driven email and Facebook campaigns.

What is Superset?

Apache Superset is a cloud-native data exploration and visualization platform that businesses can use to create business intelligence reports and dashboards. It includes a state-of-the-art SQL IDE, and it's open source software, free of cost. The platform was originally developed at Airbnb and donated to the Apache Software Foundation.

Getting data out of Klaviyo

Klaviyo exposes data through several REST APIs, which developers can use to extract information on metrics, profiles, lists, campaigns, and templates. Each of these APIs has two to seven optional parameters you can use to refine the information returned. As an example, a simple call to retrieve data via the Klaviyo Metrics API would look like:

GET https://a.klaviyo.com/api/v1/metrics

The GET call returns a JSON object with all the fields of the specified dataset as a reply. All fields may not be present for any given record. The JSON might look like:

{
  "end": 1,
  "object": "$list",
  "page_size": 50,
  "start": 0,
  "total": 2,
  "data": [
    {
      "updated": "2017-11-03 17:28:09",
      "name": "Active on Site",
      "created": "2017-11-03 17:28:09",
      "object": "metric",
      "id": "3vtCwa",
      "integration": {
        "category": "API",
        "object": "integration",
        "id": "4qYGmQ",
        "name": "API"
      }
    },
    {
      "updated": "2017-11-03 20:54:40",
      "name": "Added integration",
      "created": "2017-11-03 20:54:40",
      "object": "metric",
      "id": "8qYK7L",
      "integration": {
        "category": "API",
        "object": "integration",
        "id": "4qYGmQ",
        "name": "API"
      }
    ]
  }

Loading data into Superset

You must replicate data from your SaaS applications to a data warehouse before you can report on it using Superset. Superset can connect to almost 30 databases and data warehouses. Once you choose a data source you want to connect to, you must specify a host name and port, database name, and username and password to get access to the data. You then specify the database schema or tables you want to work with.

Keeping Klaviyo data up to date

At this point you've coded up a script or written a program to get the data you want and successfully moved it into your data warehouse. But how will you load new or updated data? It's not a good idea to replicate all of your data each time you have updated records. That process would be painfully slow and resource-intensive.

Instead, identify key fields that your script can use to bookmark its progression through the data and use to pick up where it left off as it looks for updated data. Auto-incrementing fields such as updated_at or created_at work best for this. When you've built in this functionality, you can set up your script as a cron job or continuous loop to get new data as it appears in Klaviyo.

And remember, as with any code, once you write it, you have to maintain it. If Klaviyo modifies its API, or the API sends a field with a datatype your code doesn't recognize, you may have to modify the script. If your users want slightly different information, you definitely will have to.

From Klaviyo to your data warehouse: An easier solution

As mentioned earlier, the best practice for analyzing Klaviyo data in Superset is to store that data inside a data warehousing platform alongside data from your other databases and third-party sources. You can find instructions for doing these extractions for leading warehouses on our sister sites Klaviyo to Redshift, Klaviyo to BigQuery, Klaviyo to Azure Synapse Analytics, Klaviyo to PostgreSQL, Klaviyo to Panoply, and Klaviyo to Snowflake.

Easier yet, however, is using a solution that does all that work for you. Products like Stitch were built to move data automatically, making it easy to integrate Klaviyo with Superset. With just a few clicks, Stitch starts extracting your Klaviyo data, structuring it in a way that's optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Superset.