This integration was created by Stitch for Singer, an open-source, composable ETL platform. Check out & contribute to the repo on GitHub.
Referral SaaSquatch is currently in Open Beta. The info in this article is subject to change.
Release Status | Open Beta | Availability | Free |
Status Page | Referral SaaSquatch Status Page | Default Historical Sync | 1 year |
Whitelist Tables/Columns | Unsupported/Unsupported | Default Replication Frequency | 30 minutes |
Full Table Endpoints | 0 | Incremental Endpoints | 3 |
Destination Incompatibilities | None |
Connecting Referral SaaSquatch
Connecting Stitch to Referral SaaSquatch is a four-step process:
- Retrieve your Referral SaaSquatch API credentials
- Add Referral SaaSquatch as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
Retrieving Your Referral SaaSquatch API Credentials
- Sign into your Referral SaaSquatch account.
- In the Setup section of the left nav tab, click the Install option.
- In this page, locate the Tenant Alias and API Key fields.
- 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.
Add Referral SaaSquatch as a Stitch Data Source
- On the Stitch Dashboard page, click the Add an Integration button.
-
Click the Referral SaaSquatch icon.
-
Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch Referral SaaSquatch” would create a schema called
stitch_referral_saasquatch
in the data warehouse. This schema is where all the tables for this integration will be stored. - In the Tenant Alias field, paste your Referral SaaSquatch Tenant Alias.
- In the API Key field, paste your Referral SaaSquatch API Key.
Defining the Historical Sync
The Sync Historical Data setting will define 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 sync data beyond Referral SaaSquatch’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.
Define the Replication Frequency
The Replication Frequency controls how often Stitch will attempt to replicate data from your Referral SaaSquatch integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.
Before setting the Replication Frequency, note that:
- The more often Referral SaaSquatch is set to replicate, the higher the number of replicated rows.
-
The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.
- If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.
To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.
After selecting a Replication Frequency, click Save Integration.
Referral SaaSquatch’s Intial Sync
After you finish setting up Referral SaaSquatch, you might see its Sync Status 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 sync for the integration. This may take some time to complete.
Referral SaaSquatch Schema
Stitch's Referral SaaSquatch integration includes these tables:
referrals
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
referrals
table contains info about all of the referrals in your Referral SaaSquatch tenant.referrals Attributes
Referral ID (id
)
referreduser
referredaccount
referredreward
referredmoderationstatus
referreruser
referreraccount
referrerreward
referrermoderationstatus
datereferralstarted
datereferralpaid
datereferralended
datemoderated
Referral ID (id
)
referreduser
referredaccount
referredreward
referredmoderationstatus
referreruser
referreraccount
referrerreward
referrermoderationstatus
datereferralstarted
datereferralpaid
datereferralended
datemoderated
reward_balance
Replication Method: Incremental
Primary Key: userid : accountid
Contains Nested Structures?:
No
reward_balance
table contains info about the balances for all rewards.reward_balance Attributes
userid
accountid
type
amount
unit
userid
accountid
type
amount
unit
users
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
users
table contains info about the users in your Referral SaaSquatch tenant.users Attributes
User ID (id
)
accountid
email
firstname
lastname
imageurl
firstseenip
lastseenip
datecreated
emailhash
referralsource
locale
sharelink
facebooksharelink
twittersharelink
emailsharelink
linkedinsharelink
User ID (id
)
accountid
firstname
lastname
imageurl
firstseenip
lastseenip
datecreated
emailhash
referralsource
locale
sharelink
facebooksharelink
twittersharelink
emailsharelink
linkedinsharelink
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, please reach out to us.