AfterShip to QuickSight

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

AfterShip is a tracking service platform that helps businesses track shipments. AfterShip supports more than 400 carriers, and offers a free tier to businesses that make no more than 100 shipments per month.

What is QuickSight?

Amazon QuickSight is the AWS business intelligence tool for creating dashboards and visualizations. Users are charged per session only for the time when they access dashboards or reports. QuickSight supports a variety of data sources, such as individual databases (Amazon Aurora, MariaDB, and Microsoft SQL Server), data warehouses (Amazon Redshift and Snowflake), and SaaS sources (Adobe Analytics, GitHub, and Salesforce), along with several common standard file formats.

Getting data out of AfterShip

AfterShip provides a REST API that lets you extract information from its system. If, for example, you wanted to retrieve a list of trackings, you could call GET /trackings.

Sample AfterShip data

The AfterShip API returns data in JSON format. For example, the result of a call to retrieve a list of trackings might look like this:

{
    "meta": {
        "code": 200
    },
    "data": {
        "page": 1,
        "limit": 100,
        "count": 3,
        "keyword": "",
        "slug": "",
        "origin": [],
        "destination": [],
        "tag": "",
        "fields": "",
        "created_at_min": "2017-03-27T07:36:14+00:00",
        "created_at_max": "2017-06-25T07:36:14+00:00",
        "trackings": [
            {
                "id": "53aa7b5c415a670000000021",
                "created_at": "2017-06-25T07:33:48+00:00",
                "updated_at": "2017-06-25T07:33:55+00:00",
                "tracking_number": "123456789",
                "tracking_account_number": null,
                "tracking_postal_code": null,
                "tracking_ship_date": null,
                "slug": "dhl",
                "active": false,
                "custom_fields": {
                    "product_price": "USD19.99",
                    "product_name": "iPhone Case"
                },
                "customer_name": null,
                "destination_country_iso3": null,
                "emails": [
                    "email@yourdomain.com",
                    "another_email@yourdomain.com"
                ],
                "expected_delivery": null,
                "note": null,
                "order_id": "ID 1234",
                "order_id_path": "http://www.aftership.com/order_id=1234",
                "origin_country_iso3": null,
                "shipment_package_count": 0,
                "shipment_type": null,
                "signed_by": "raul",
                "smses": [],
                "source": "api",
                "tag": "Delivered",
                "title": "Title Name",
                "tracked_count": 1,
                "unique_token": "xy_fej9Llg",
                "checkpoints": [
                    {
                        "slug": "dhl",
                        "city": null,
                        "created_at": "2017-06-25T07:33:53+00:00",
                        "country_name": "VALENCIA - SPAIN",
                        "message": "Awaiting collection by recipient as requested",
                        "country_iso3": null,
                        "tag": "InTransit",
                        "checkpoint_time": "2017-05-12T12:02:00",
                        "coordinates": [],
                        "state": null,
                        "zip": null
                    }
                ]
            }
        ]
    }
}

Loading data into QuickSight

You must replicate data from your SaaS applications to a data warehouse (such as Redshift) before you can report on it using QuickSight. Once you specify 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 choose the schema you want to work with, and a table within that schema. You can add additional tables by specifying them as new datasets from the main QuickSight page.

Using data in QuickSight

QuickSights provides both a visual report builder and the ability to use SQL to select, join, and sort data. QuickSight lets you combine visualizations into dashboards that you can share with others, and automatically generate and send reports via email.

Keeping AfterShip 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 AfterShip.

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

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