Release Status Released Supported By Singer community
Availability Free Status Page Referral SaaSquatch Status Page
Default Historical Sync 1 year Default Replication Frequency 30 minutes
Whitelisting Unsupported Destination Incompatibilities None

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 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 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.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To help prevent overages, 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 Schemas

Replication Method: Key-based Incremental Replication Key : n/a
Primary Key : id Documentation: Official Docs

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

id
STRING

The referral ID.

referredUser
STRING

The ID of the referred user.

referredAccount
STRING

The account ID of the referred user.

referredReward
STRING

The ID for the referred user’s reward.

referredModerationStatus
STRING

The moderation status of the referred user, which affects reward cancellation. Possible values are PENDING, APPROVED, and DENIED.

referrerUser
STRING

The ID of the referring user.

referrerAccount
STRING

The account ID of the referring user.

referrerReward
STRING

The ID for the referring user’s reward.

referrerModerationStatus
STRING

The moderation status of the referring user, which affects reward cancellation. Possible values are PENDING, APPROVED, and DENIED.

dateReferralStarted
DATE-TIME

The time of when the referral was started.

dateReferralPaid
DATE-TIME

The time of when the referral was marked as PAID.

dateReferralEnded
DATE-TIME

The time of when the referral was ended.

dateModerated
DATE-TIME

The time of when the referral was last moderated.


Replication Method: Key-based Incremental Replication Key : n/a
Primary Key : userId : accountId Documentation: Official Docs

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

userId
STRING

The user ID.

accountId
STRING

The ID of the account the user belongs to.

type
STRING

The type of reward. Possible values are PCT_DISCOUNT, FEATURE, TIME_CREDIT, or CREDIT.

amount
INTEGER

The amount of credit remaining.

unit
STRING

The unit of the reward. For example: tshirt.


Replication Method: Key-based Incremental Replication Key : n/a
Primary Key : id : accountId Documentation: Official Docs

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

id
STRING

The user ID.

accountId
STRING

The ID of the account the user belongs to.

email
STRING

The user’s email address.

firstName
STRING

The first name of the user.

lastName
STRING

The last name of the user.

imageUrl
STRING

The URL of the image associated with the user.

firstSeenIp
STRING

The user’s IP address on identification.

lastSeenIp
STRING

The user’s last known IP address.

dateCreated
DATE-TIME

The Unix timestamp of when the user was created.

emailHash
STRING

The hash of the user’s email address.

referralSource
STRING

The domain from which the user registered.

locale
STRING

The user’s locale, in language_COUNTRY format. For example: en_US

shareLink
STRING

The user’s unique share link.

facebookShareLink
STRING

The share link for Facebook.

twitterShareLink
STRING

The share link for Twitter.

emailShareLink
STRING

The share link for email.

linkedInShareLink
STRING

The share link for LinkedIn.



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.