Referral SaaSquatch

Referral SaaSquatch is a cloud-based loyalty, referral and rewards marketing platform.

Referral SaaSquatch integration replicates data using the Referral SaaSquatch REST API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

You must have the Full Access role in your Referral SaaSquatch admin portal.

To retrieve your API key and tenant alias:

Log into your Referral SaaSquatch account.
Choose your tenant from the tenant selection dropdown.
Go to Settings > General.
In the Tenant details section, click the eye icon to reveal the API key and locate the Tenant Alias field.
Copy and paste your API key and tenant alias into a secured file.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
API Key	API key.
Tenant Alias	Tenant alias.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

referrals

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

Replication Method

CDC

Primary Key

Useful links

Referral SaaSquatch documentation

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

Join referrals with

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

OBJECT

This is a nested data structure.

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

CDC

Primary Keys

userId

accountId

Useful links

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

Join reward_balances with

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

This is a nested data structure.

amount

INTEGER

type

STRING

unit

STRING

userId

OBJECT

This is a nested data structure.

users

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

Replication Method

CDC

Primary Keys

accountId

Useful links

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

Join users with

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

This is a nested data structure.

dateCreated

DATE-TIME

email

STRING

emailHash

STRING

emailShareLink

STRING

facebookShareLink

STRING

firstName

STRING

firstSeenIP

STRING

OBJECT

This is a nested data structure.

imageUrl

STRING

lastName

STRING

lastSeenIP

STRING

linkedinShareLink

STRING

locale

STRING

referralSource

STRING

shareLink

STRING

twitterShareLink

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here