Shippo to Superset

This page provides you with instructions on how to extract data from Shippo and analyze it in Superset. (If the mechanics of extracting data from Shippo 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 Shippo?

Shippo provides a web platform and API that helps businesses coordinate and track shipping with multiple carriers.

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 Shippo

Shippo provides a REST API that lets you get information about shipments, manifests, rates, and many more elements. If, for example, you wanted to retrieve a customs declaration, you could call GET /customs/declarations/[objectID].

Sample Shippo data

The Shippo API returns data in JSON format. For example, the result of a call to retrieve a customs declaration might look like this:

   "certify_signer":"Oscar Potamus",
   "contents_explanation":"T-Shirt purchase",
   "metadata":"Order ID #123123",
   "test": true

Preparing Shippo data

If you don't already have a data structure in which to store the data you retrieve, you'll have to create a schema for your data tables. Then, for each value in the response, you'll need to identify a predefined datatype (INTEGER, DATETIME, etc.) and build a table that can receive them. Shippo's API documentation should tell you what fields are provided by each endpoint, along with their corresponding datatypes.

Complicating things is the fact that the records retrieved from the source may not always be "flat" – some of the objects may actually be lists. This means you'll likely have to create additional tables to capture the unpredictable cardinality in each record.

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

And remember, as with any code, once you write it, you have to maintain it. If Shippo 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 Shippo to your data warehouse: An easier solution

As mentioned earlier, the best practice for analyzing Shippo 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 Shippo to Redshift, Shippo to BigQuery, Shippo to Azure Synapse Analytics, Shippo to PostgreSQL, Shippo to Panoply, and Shippo 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 Shippo with Superset. With just a few clicks, Stitch starts extracting your Shippo 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.