Referral SaaSquatch to Power BI

This page provides you with instructions on how to extract data from Referral SaaSquatch and analyze it in Power BI. (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 Power BI?

Power BI is Microsoft’s business intelligence offering. It's a powerful platform that includes capabilities for data modeling, visualization, dashboarding, and collaboration. Many enterprises that use Microsoft's other products can get easy access to Power BI and choose it for its convenience, security, and power.

With high-value use cases across analysts, IT, business users, and developers, Power BI offers a comprehensive set of functionality that has consistently landed Microsoft in Gartner's "Leaders" quadrant for Business Intelligence.

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 Power BI

You can analyze any data in Power BI, as long as that data exists in a data warehouse that's connected to your Power BI account. The most common data warehouses include Amazon Redshift, Google BigQuery, and Snowflake. Microsoft also has its own data warehousing platform called Azure SQL Data Warehouse.

Connecting these data warehouses to Power BI is relatively simple. The Get Data menu in the Power BI interface allows you to import data from a number of sources, including static files and data warehouses. You'll find each of the warehouses mentioned above among the options in the Database list. The Power BI documentation provides more details on each.

Analyzing data in Power BI

In Power BI, each table in the data warehouse you connect is known as a dataset, and the analyses conducted on these datasets are known as reports. To create a report, use Power BI’s report editor, a visual interface for building and editing reports.

The report editor guides you through several selections in the course of building a report: the visualization type, fields being used in the report, filters being applied, any formatting you wish to apply, and additional analytics you may wish to layer onto your report, such as trendlines or averages. You can explore all of the features related to analyzing and tracking data in the Power BI documentation.

Once you've created a report, Power BI lets you share it with report "consumers" in your organization.

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 Power BI 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, 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 solve this problem automatically. With just a few clicks, Stitch starts extracting your Referral SaaSquatch data via the API, structuring it in a way that is optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Power BI.