Referral SaaSquatch to Metabase

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

Referral SaaSquatch hosts a cloud-based customer referral marketing platform for small and medium-sized businesses.

What is Metabase?

Metabase provides a visual query builder that lets users generate simple charts and dashboards, and supports SQL for gathering data for more complex business intelligence visualizations. It runs as a JAR file, and its developers make it available in a Docker container and on Heroku and AWS. Metabase is free of cost and open source, licensed under the AGPL.

Getting data out of Referral SaaSquatch

Referral SaaSquatch supports a REST API that exposes data stored in its system about accounts, users, referrals, rewards, and more. For example, to get a list of referrals for a given tenant, you would call GET /api/v1/[tenant_alias]/referrals. This call accepts any of eight optional arguments that let you filter the results it delivers.

Sample Referral SaaSquatch data

The Referral SaaSquatch API returns JSON-format data. The data returned for a "list referrals" request might look like this:

{
    "count": 2,
    "totalCount": 4,
    "referrals": [
        {
            "id": "5462600de4b09b1c41108f28",
            "referredUser": {
                "id": "898746321",
                "accountId": "987321",
                "email": "hello@example.com",
                "firstName": "Henk",
                "lastName": "Thompson",
                "referralCode": "HENKTHOMPSON",
                "imageUrl": "",
                "firstSeenIP": "10.230.163.157",
                "lastSeenIP": "184.66.242.57",
                "dateCreated": 1467222395030,
                "emailHash": "180bc1412a038746af9b37fb782724a2",
                "referralSource": "http://unifiedtestapp.herokuapp.com/",
                "locale": null,
                "shareLinks": {
                    "shareLink": "http://ssqt.co/mvbcF5",
                    "facebookShareLink": "http://ssqt.co/mmbcF5",
                    "twitterShareLink": "http://ssqt.co/mRbcF5",
                    "emailShareLink": "http://ssqt.co/mLbcF5",
                    "linkedinShareLink": "http://ssqt.co/mLbcF5",
                    "mobileShareLink": "http://ssqt.co/mebcF5",
                    "mobileFacebookShareLink": "http://ssqt.co/mnbcF5",
                    "mobileTwitterShareLink": "http://ssqt.co/mCbcF5",
                    "mobileEmailShareLink": "http://ssqt.co/mEbcF5",
                    "EMBED": {
                        "shareLink": "http://ssqt.co/mQbcF5",
                        "facebookShareLink": "http://ssqt.co/mwbcF5",
                        "twitterShareLink": "http://ssqt.co/mcbcF5",
                        "emailShareLink": "http://ssqt.co/mJbcF5",
                        "linkedinShareLink": "http://ssqt.co/mHbcF5"
                    },
                    "POPUP": {
                        "shareLink": "http://ssqt.co/m5bcF5",
                        "facebookShareLink": "http://ssqt.co/m9bcF5",
                        "twitterShareLink": "http://ssqt.co/mMbcF5",
                        "emailShareLink": "http://ssqt.co/mobcF5",
                        "linkedinShareLink": "http://ssqt.co/m7bcF5"
                    },
                    "HOSTED": {
                        "shareLink": "http://ssqt.co/mtbcF5",
                        "facebookShareLink": "http://ssqt.co/mubcF5",
                        "twitterShareLink": "http://ssqt.co/mSbcF5",
                        "emailShareLink": "http://ssqt.co/mlbcF5",
                        "linkedinShareLink": "http://ssqt.co/mYbcF5"
                    },
                    "MOBILE": {
                        "shareLink": "http://ssqt.co/mebcF5",
                        "facebookShareLink": "http://ssqt.co/mnbcF5",
                        "twitterShareLink": "http://ssqt.co/mCbcF5",
                        "emailShareLink": "http://ssqt.co/mEbcF5",
                        "linkedinShareLink": "http://ssqt.co/m3bcF5"
                    },
                    "EMAIL": {
                        "shareLink": "http://ssqt.co/mPbcF5",
                        "facebookShareLink": "http://ssqt.co/mTbcF5",
                        "twitterShareLink": "http://ssqt.co/mGbcF5",
                        "emailShareLink": "http://ssqt.co/mbbcF5",
                        "linkedinShareLink": "http://ssqt.co/m1bcF5"
                    }
                }
            },
            "referrerUser": {
                "id": "898746321",
                "accountId": "987321",
                "email": "hello@example.com",
                "firstName": "Henk",
                "lastName": "Thompson",
                "referralCode": "HENKTHOMPSON",
                "imageUrl": "",
                "firstSeenIP": "10.230.163.157",
                "lastSeenIP": "184.66.242.57",
                "dateCreated": 1467222395030,
                "emailHash": "180bc1412a038746af9b37fb782724a2",
                "referralSource": "http://unifiedtestapp.herokuapp.com/",
                "locale": null,
                "shareLinks": {
                    "shareLink": "http://ssqt.co/mvbcF5",
                    "facebookShareLink": "http://ssqt.co/mmbcF5",
                    "twitterShareLink": "http://ssqt.co/mRbcF5",
                    "emailShareLink": "http://ssqt.co/mLbcF5",
                    "linkedinShareLink": "http://ssqt.co/mLbcF5",
                    "mobileShareLink": "http://ssqt.co/mebcF5",
                    "mobileFacebookShareLink": "http://ssqt.co/mnbcF5",
                    "mobileTwitterShareLink": "http://ssqt.co/mCbcF5",
                    "mobileEmailShareLink": "http://ssqt.co/mEbcF5",
                    "EMBED": {
                        "shareLink": "http://ssqt.co/mQbcF5",
                        "facebookShareLink": "http://ssqt.co/mwbcF5",
                        "twitterShareLink": "http://ssqt.co/mcbcF5",
                        "emailShareLink": "http://ssqt.co/mJbcF5",
                        "linkedinShareLink": "http://ssqt.co/mHbcF5"
                    },
                    "POPUP": {
                        "shareLink": "http://ssqt.co/m5bcF5",
                        "facebookShareLink": "http://ssqt.co/m9bcF5",
                        "twitterShareLink": "http://ssqt.co/mMbcF5",
                        "emailShareLink": "http://ssqt.co/mobcF5",
                        "linkedinShareLink": "http://ssqt.co/m7bcF5"
                    },
                    "HOSTED": {
                        "shareLink": "http://ssqt.co/mtbcF5",
                        "facebookShareLink": "http://ssqt.co/mubcF5",
                        "twitterShareLink": "http://ssqt.co/mSbcF5",
                        "emailShareLink": "http://ssqt.co/mlbcF5",
                        "linkedinShareLink": "http://ssqt.co/mYbcF5"
                    },
                    "MOBILE": {
                        "shareLink": "http://ssqt.co/mebcF5",
                        "facebookShareLink": "http://ssqt.co/mnbcF5",
                        "twitterShareLink": "http://ssqt.co/mCbcF5",
                        "emailShareLink": "http://ssqt.co/mEbcF5",
                        "linkedinShareLink": "http://ssqt.co/m3bcF5"
                    },
                    "EMAIL": {
                        "shareLink": "http://ssqt.co/mPbcF5",
                        "facebookShareLink": "http://ssqt.co/mTbcF5",
                        "twitterShareLink": "http://ssqt.co/mGbcF5",
                        "emailShareLink": "http://ssqt.co/mbbcF5",
                        "linkedinShareLink": "http://ssqt.co/m1bcF5"
                    }
                }
            },
            "referredReward": {
                "id": "5462600de4b09b1c41108f2e",
                "type": "PCT_DISCOUNT",
                "dateGiven": 1415733261275,
                "dateExpires": null,
                "dateCancelled": null,
                "accountId": "613611",
                "userId": "876343",
                "cancellable": true,
                "rewardSource": "REFERRED",
                "discountPercent": 20,
                "unit": "%"
            },
            "referrerReward": null,
            "moderationStatus": "ACTIONED",
            "dateReferralStarted": 1415733261238,
            "dateReferralPaid": null,
            "dateReferralEnded": null,
            "dateModerated": 1427410131006,
            "referredModerationStatus": "APPROVED",
            "referrerModerationStatus": "APPROVED"
        },
        {
            "id": "546270a6e4b0c1871186a920",
            "referredUser": {
                "id": "898746321",
                "accountId": "987321",
                "email": "hello@example.com",
                "firstName": "Henk",
                "lastName": "Thompson",
                "referralCode": "HENKTHOMPSON",
                "imageUrl": "",
                "firstSeenIP": "10.230.163.157",
                "lastSeenIP": "184.66.242.57",
                "dateCreated": 1467222395030,
                "emailHash": "180bc1412a038746af9b37fb782724a2",
                "referralSource": "http://unifiedtestapp.herokuapp.com/",
                "locale": null,
                "shareLinks": {
                    "shareLink": "http://ssqt.co/mvbcF5",
                    "facebookShareLink": "http://ssqt.co/mmbcF5",
                    "twitterShareLink": "http://ssqt.co/mRbcF5",
                    "emailShareLink": "http://ssqt.co/mLbcF5",
                    "linkedinShareLink": "http://ssqt.co/mLbcF5",
                    "mobileShareLink": "http://ssqt.co/mebcF5",
                    "mobileFacebookShareLink": "http://ssqt.co/mnbcF5",
                    "mobileTwitterShareLink": "http://ssqt.co/mCbcF5",
                    "mobileEmailShareLink": "http://ssqt.co/mEbcF5",
                    "EMBED": {
                        "shareLink": "http://ssqt.co/mQbcF5",
                        "facebookShareLink": "http://ssqt.co/mwbcF5",
                        "twitterShareLink": "http://ssqt.co/mcbcF5",
                        "emailShareLink": "http://ssqt.co/mJbcF5",
                        "linkedinShareLink": "http://ssqt.co/mHbcF5"
                    },
                    "POPUP": {
                        "shareLink": "http://ssqt.co/m5bcF5",
                        "facebookShareLink": "http://ssqt.co/m9bcF5",
                        "twitterShareLink": "http://ssqt.co/mMbcF5",
                        "emailShareLink": "http://ssqt.co/mobcF5",
                        "linkedinShareLink": "http://ssqt.co/m7bcF5"
                    },
                    "HOSTED": {
                        "shareLink": "http://ssqt.co/mtbcF5",
                        "facebookShareLink": "http://ssqt.co/mubcF5",
                        "twitterShareLink": "http://ssqt.co/mSbcF5",
                        "emailShareLink": "http://ssqt.co/mlbcF5",
                        "linkedinShareLink": "http://ssqt.co/mYbcF5"
                    },
                    "MOBILE": {
                        "shareLink": "http://ssqt.co/mebcF5",
                        "facebookShareLink": "http://ssqt.co/mnbcF5",
                        "twitterShareLink": "http://ssqt.co/mCbcF5",
                        "emailShareLink": "http://ssqt.co/mEbcF5",
                        "linkedinShareLink": "http://ssqt.co/m3bcF5"
                    },
                    "EMAIL": {
                        "shareLink": "http://ssqt.co/mPbcF5",
                        "facebookShareLink": "http://ssqt.co/mTbcF5",
                        "twitterShareLink": "http://ssqt.co/mGbcF5",
                        "emailShareLink": "http://ssqt.co/mbbcF5",
                        "linkedinShareLink": "http://ssqt.co/m1bcF5"
                    }
                }
            },
            "referrerUser": {
                "id": "898746321",
                "accountId": "987321",
                "email": "hello@example.com",
                "firstName": "Henk",
                "lastName": "Thompson",
                "referralCode": "HENKTHOMPSON",
                "imageUrl": "",
                "firstSeenIP": "10.230.163.157",
                "lastSeenIP": "184.66.242.57",
                "dateCreated": 1467222395030,
                "emailHash": "180bc1412a038746af9b37fb782724a2",
                "referralSource": "http://unifiedtestapp.herokuapp.com/",
                "locale": null,
                "shareLinks": {
                    "shareLink": "http://ssqt.co/mvbcF5",
                    "facebookShareLink": "http://ssqt.co/mmbcF5",
                    "twitterShareLink": "http://ssqt.co/mRbcF5",
                    "emailShareLink": "http://ssqt.co/mLbcF5",
                    "linkedinShareLink": "http://ssqt.co/mLbcF5",
                    "mobileShareLink": "http://ssqt.co/mebcF5",
                    "mobileFacebookShareLink": "http://ssqt.co/mnbcF5",
                    "mobileTwitterShareLink": "http://ssqt.co/mCbcF5",
                    "mobileEmailShareLink": "http://ssqt.co/mEbcF5",
                    "EMBED": {
                        "shareLink": "http://ssqt.co/mQbcF5",
                        "facebookShareLink": "http://ssqt.co/mwbcF5",
                        "twitterShareLink": "http://ssqt.co/mcbcF5",
                        "emailShareLink": "http://ssqt.co/mJbcF5",
                        "linkedinShareLink": "http://ssqt.co/mHbcF5"
                    },
                    "POPUP": {
                        "shareLink": "http://ssqt.co/m5bcF5",
                        "facebookShareLink": "http://ssqt.co/m9bcF5",
                        "twitterShareLink": "http://ssqt.co/mMbcF5",
                        "emailShareLink": "http://ssqt.co/mobcF5",
                        "linkedinShareLink": "http://ssqt.co/m7bcF5"
                    },
                    "HOSTED": {
                        "shareLink": "http://ssqt.co/mtbcF5",
                        "facebookShareLink": "http://ssqt.co/mubcF5",
                        "twitterShareLink": "http://ssqt.co/mSbcF5",
                        "emailShareLink": "http://ssqt.co/mlbcF5",
                        "linkedinShareLink": "http://ssqt.co/mYbcF5"
                    },
                    "MOBILE": {
                        "shareLink": "http://ssqt.co/mebcF5",
                        "facebookShareLink": "http://ssqt.co/mnbcF5",
                        "twitterShareLink": "http://ssqt.co/mCbcF5",
                        "emailShareLink": "http://ssqt.co/mEbcF5",
                        "linkedinShareLink": "http://ssqt.co/m3bcF5"
                    },
                    "EMAIL": {
                        "shareLink": "http://ssqt.co/mPbcF5",
                        "facebookShareLink": "http://ssqt.co/mTbcF5",
                        "twitterShareLink": "http://ssqt.co/mGbcF5",
                        "emailShareLink": "http://ssqt.co/mbbcF5",
                        "linkedinShareLink": "http://ssqt.co/m1bcF5"
                    }
                }
            },
            "referredReward": {
                "id": "5462600de4b09b1c41108f2e",
                "type": "PCT_DISCOUNT",
                "dateGiven": 1415733261275,
                "dateExpires": null,
                "dateCancelled": null,
                "accountId": "613611",
                "userId": "876343",
                "cancellable": true,
                "rewardSource": "REFERRED",
                "discountPercent": 20,
                "unit": "%"
            },
            "referrerReward": {
                "id": "5462600de4b09b1c41108f2e",
                "type": "PCT_DISCOUNT",
                "dateGiven": 1415733261275,
                "dateExpires": null,
                "dateCancelled": null,
                "accountId": "613611",
                "userId": "876343",
                "cancellable": true,
                "rewardSource": "REFERRED",
                "discountPercent": 20,
                "unit": "%"
            },
            "moderationStatus": "ACTIONED",
            "dateReferralStarted": 1415737510411,
            "dateReferralPaid": 1415737557217,
            "dateReferralEnded": null,
            "dateModerated": 1427410131029,
            "referredModerationStatus": "APPROVED",
            "referrerModerationStatus": "APPROVED",
            "fraudSignals": {
                "ip": {
                    "message": "Referrer and referred came from the same IP",
                    "score": 50
                }
            }
        }
    ]
}

Preparing Referral SaaSquatch 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. The source 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 Metabase

Metabase works with data in databases; you can't use it as a front end for a SaaS application without replicating the data to a data warehouse first. Out of the box Metabase supports 15 database sources, and you can download 10 additional third-party database drivers, or write your own. Once you specify the source, you must specify a host name and port, database name, and username and password to get access to the data.

Using data in Metabase

Metabase supports three kinds of queries: simple, custom, and SQL. Users create simple queries entirely through a visual drag-and-drop interface. Custom queries use a notebook-style editor that lets users select, filter, summarize, and otherwise customize the presentation of the data. The SQL editor lets users type or paste in SQL queries.

Keeping Referral SaaSquatch 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 Referral SaaSquatch.

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

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