This integration is powered by Singer's Referral SaaSquatch tap. For support, visit the GitHub repo or join the Singer Slack.
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 integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release Status |
Released |
Supported By | |
Stitch Plan |
Free |
Singer GitHub Repository | |
DATA SELECTION | |||
Table Selection |
Unsupported |
Column Selection |
Unsupported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Referral SaaSquatch
Step 1: Retrieve 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.
Step 2: Add Referral SaaSquatch as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Referral SaaSquatch icon.
-
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. - In the Tenant Alias field, paste your Referral SaaSquatch Tenant Alias.
- In the API Key field, paste your Referral SaaSquatch API Key.
Step 3: Define 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 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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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 schemas
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
referrals
Replication Method : |
Key-based Incremental |
Replication Key : |
createdOrUpdatedSince |
Primary Key : |
id |
API endpoint : |
The referrals
table contains info about all of the referrals in your Referral SaaSquatch tenant.
id
The referral ID. |
referredUser
The ID of the referred user. Reference: |
referredAccount
The account ID of the referred user. Reference: |
referredReward
The ID for the referred user’s reward. |
referredModerationStatus
The moderation status of the referred user, which affects reward cancellation. Possible values are |
referrerUser
The ID of the referring user. Reference: |
referrerAccount
The account ID of the referring user. Reference: |
referrerReward
The ID for the referring user’s reward. |
referrerModerationStatus
The moderation status of the referring user, which affects reward cancellation. Possible values are |
dateReferralStarted
The time of when the referral was started. |
dateReferralPaid
The time of when the referral was marked as |
dateReferralEnded
The time of when the referral was ended. |
dateModerated
The time of when the referral was last moderated. |
reward_balance
Replication Method : |
Key-based Incremental |
Replication Key : |
createdOrUpdatedSince |
Primary Key : |
userId : accountId |
API endpoint : |
The reward_balance
table contains info about the balances for all rewards.
userId
The user ID. Reference: |
accountId
The ID of the account the user belongs to. Reference: |
type
The type of reward. Possible values are |
amount
The amount of credit remaining. |
unit
The unit of the reward. For example: |
Replication Method : |
Key-based Incremental |
Replication Key : |
createdOrUpdatedSince |
Primary Key : |
id : accountId |
API endpoint : |
The users
table contains info about the users in your Referral SaaSquatch tenant.
id
The user ID. Reference: |
accountId
The ID of the account the user belongs to. Reference: |
email
The user’s email address. |
firstName
The first name of the user. |
lastName
The last name of the user. |
imageUrl
The URL of the image associated with the user. |
firstSeenIp
The user’s IP address on identification. |
lastSeenIp
The user’s last known IP address. |
dateCreated
The Unix timestamp of when the user was created. |
emailHash
The hash of the user’s email address. |
referralSource
The domain from which the user registered. |
locale
The user’s locale, in |
shareLink
The user’s unique share link. |
facebookShareLink
The share link for Facebook. |
twitterShareLink
The share link for Twitter. |
emailShareLink
The share link for email. |
linkedInShareLink
The share link for LinkedIn. |
Related | Troubleshooting |
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.