Referral SaaSquatch integration summary

Stitch’s Referral SaaSquatch integration replicates data using the Referral SaaSquatch REST API. Refer to the Schema section for a list of objects available for replication.

Referral SaaSquatch feature snapshot

A high-level look at Stitch's Referral SaaSquatch (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on March 1, 2017

Supported by

Singer Community

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-referral-saasquatch

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Unsupported

Column selection

Unsupported

Select all

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Referral SaaSquatch

Step 1: Retrieve your Referral SaaSquatch API credentials

  1. Sign into your Referral SaaSquatch account.
  2. In the Setup section of the left nav tab, click the Install option.
  3. In this page, locate the Tenant Alias and API Key fields.
  4. In the API Key field, click the Click to Reveal link to reveal your API Key.

Leave this page open for now - you’ll need it to complete the setup in Stitch.

Step 2: Add Referral SaaSquatch as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Referral SaaSquatch icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Referral SaaSquatch” would create a schema called stitch_referral_saasquatch in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Tenant Alias field, paste your Referral SaaSquatch Tenant Alias.
  6. In the API Key field, paste your Referral SaaSquatch API Key.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Referral SaaSquatch integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Referral SaaSquatch’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Referral SaaSquatch integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Referral SaaSquatch, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Referral SaaSquatch table reference

referrals

The referrals table contains info about all of the referrals in your Referral SaaSquatch tenant.

Replication Method

Key-based Incremental

Primary Key

id

Useful links

Referral SaaSquatch documentation

referrals schema on GitHub

Referral SaaSquatch API method

Join referrals with on
reward_balances
referrals.referredUser = reward_balances.userId
referrals.referrerUser = reward_balances.userId
referrals.referredAccount = reward_balances.accountId
referrals.referrerAccount = reward_balances.accountId
users
referrals.referredUser = users.id
referrals.referrerUser = users.id
referrals.referredAccount = users.accountId
referrals.referrerAccount = users.accountId

dateConverted

DATE-TIME

dateModerated

DATE-TIME

dateReferralEnded

DATE-TIME

dateReferralPaid

DATE-TIME

dateReferralStarted

DATE-TIME

id

OBJECT

programId

STRING

referredAccount

STRING

referredModerationStatus

STRING

referredReward

STRING

referredUser

STRING

referrerAccount

STRING

referrerModerationStatus

STRING

referrerReward

STRING

referrerUser

STRING

reward_balances

The reward_balances table contains info about the balances for all rewards.

Replication Method

Key-based Incremental

Primary Keys

userId

accountId

Useful links

reward_balances schema on GitHub

Referral SaaSquatch API method

Join reward_balances with on
referrals
reward_balances.userId = referrals.referredUser
reward_balances.userId = referrals.referrerUser
reward_balances.accountId = referrals.referredAccount
reward_balances.accountId = referrals.referrerAccount
users
reward_balances.userId = users.id
reward_balances.accountId = users.accountId

accountId

OBJECT

amount

INTEGER

type

STRING

unit

STRING

userId

OBJECT

users

The users table contains info about the users in your Referral SaaSquatch tenant.

Replication Method

Key-based Incremental

Primary Keys

id

accountId

Useful links

users schema on GitHub

Referral SaaSquatch API method

Join users with on
referrals
users.id = referrals.referredUser
users.id = referrals.referrerUser
users.accountId = referrals.referredAccount
users.accountId = referrals.referrerAccount
reward_balances
users.id = reward_balances.userId
users.accountId = reward_balances.accountId

accountId

OBJECT

dateCreated

DATE-TIME

email

STRING

emailHash

STRING

emailShareLink

STRING

facebookShareLink

STRING

firstName

STRING

firstSeenIP

STRING

id

OBJECT

imageUrl

STRING

lastName

STRING

lastSeenIP

STRING

linkedinShareLink

STRING

locale

STRING

referralSource

STRING

shareLink

STRING

twitterShareLink

STRING


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.