Help Center

| Submit or View Help Requests | Developer Docs |

View desktop instructions
View mobile app instructions
Import Referral Program Data from SaaSquatch

This article houses useful references to assist you in importing your referral platform data from SaaSquatch to impact.com.

CSV file column reference

Users data file

Column

Required

Description

User ID

[Checked box green]

The participant's identifier.

Account ID

[Checked box green]

The participant's account identifier.

Email

times-solid.svg

The participant's email address.

First Name

times-solid.svg

The participant's first name.

Last Name

times-solid.svg

The participant's last name.

Referral Code

times-solid.svg

The participant's primary program referral code (if specified).

Image URL

times-solid.svg

The participant's image URL.

First Seen IP

times-solid.svg

The IP address of the participant the first time they did a non-API upsert.

Last Seen IP

times-solid.svg

The IP address of the participant the last time they did a non-API upsert.

Date Created

times-solid.svg

The date this participant user was created, formatted in milliseconds since unix epoch External Link.

Email Hash

times-solid.svg

The MD5 hash value of a participant's email address.

Locale

times-solid.svg

The participant's geographical location.

Country Code

times-solid.svg

The participant's country code.

Segments

times-solid.svg

The participant's user segments.

Share Link

times-solid.svg

The participant's primary program (if specified) share link.

Facebook Share Link

times-solid.svg

The participant's primary program (if specified) Facebook share link.

Twitter Share Link

times-solid.svg

The participant's primary program (if specified) Twitter/X share link.

Email Share Link

times-solid.svg

The participant's primary program (if specified) email share link.

LinkedIn Share Link

times-solid.svg

The participant's primary program (if specified) LinkedIn share link.

Clean Share Link

times-solid.svg

The participant's primary vanity link without encoding.

Custom Field

times-solid.svg

If a participant has a custom field, {ExampleName} will be the field name.

Referral data file

Column

Required

Description

Referred User - User ID

[Checked box green]

The referred friend's external user id.

Referred User - Account ID

[Checked box green]

The referred friend's external account id.

Referring User - User ID

[Checked box green]

The customer advocate's external user id.

Referring User - Account ID

[Checked box green]

The customer advocate's external account id.

Referral ID

times-solid.svg

The referral's unique identifier.

Date Modified

times-solid.svg

The date the referral was last modified (i.e. started, converted, moderated, etc.), formatted in milliseconds since unix epoch External Link.

Date Referral Started

times-solid.svg

The date the referral was created, formatted in milliseconds since unix epoch External Link.

Date Converted

times-solid.svg

The date the first goal was achieved, formatted in milliseconds since unix epoch External Link.

Date User Modified

times-solid.svg

The date a user was deleted from a referral (user deletion) or added to a referral, formatted in milliseconds since unix epoch External Link.

Program ID

times-solid.svg

The identifier of the program for which the referral was created.

Program Name

times-solid.svg

The name of the program for which the referral was created.

Referred User - Email

times-solid.svg

The referred friend's email address.

Referred User - First Name

times-solid.svg

The referred friend's first name.

Referred User - Last Name

times-solid.svg

The referred friend's last name.

Referred User - Referral Code

times-solid.svg

The referred friend's primary referral code (depends on the program in which this referral was created.

Referred User - First Seen IP

times-solid.svg

The first IP address the referred friend used when loading a widget.

Referred User - Last Seen IP

times-solid.svg

The most recent IP address the referred friend used when loading widget.

Referred User - Image URL

times-solid.svg

The referred friend's image.

Referred User - Locale

times-solid.svg

The locale of the referred friend.

Referred User - Date Created

times-solid.svg

The date the referred friend was first seen by SaaSquatch (created in SaaSquatch), formatted in milliseconds since unix epoch External Link.

Referred User - Segments

times-solid.svg

The referred friend's user segments.

referredUserCustomFields.<fieldName>

times-solid.svg

The referred friend's custom fields.

Referring User - Email

times-solid.svg

The customer advocate's email address.

Referring User - First Name

times-solid.svg

The customer advocate's first name.

Referring User - Last Name

times-solid.svg

The customer advocate's last name.

Referring User - Referral Code

times-solid.svg

The customer advocate's primary referral code (e.g. the referral code used to create this referral).

Referring User - First Seen IP

times-solid.svg

The first IP address the customer advocate used when loading a widget.

Referring User - Last Seen IP

times-solid.svg

The most recent IP address the customer advocate used when loading a widget.

Referring User - Image URL

times-solid.svg

The customer advocate's image.

Referring User - Locale

times-solid.svg

The locale of the customer advocate's.

Referring User - Date Created

times-solid.svg

The date the customer advocate was first seen by SaaSquatch (created in SaaSquatch), formatted in milliseconds since unix epoch External Link.

Moderation Status

times-solid.svg

The referral fraud moderation status (e.g., PENDING, ACTIONED).

Date Moderated

times-solid.svg

The date the referral started, formatted in milliseconds since unix epoch External Link.

Referred User - Reward ID

times-solid.svg

The referred friend's reward identifier.

Referring User - Reward ID

times-solid.svg

The customer advocate's reward identifier.

Referrer User - Segments

times-solid.svg

The customer advocate's user segments.

referrerUserCustomFields.<fieldName>

times-solid.svg

The customer advocate's custom fields.

Referral Code Used

times-solid.svg

The customer advocate's referral code that was used for the referral.

Share Link Used

times-solid.svg

The customer advocate's share link that was used for the referral.

Reward data file

Column

Required

Description

User ID

[Checked box green]

The user's identifier.

Account ID

[Checked box green]

The user's account identifier.

Type

times-solid.svg

The type of reward, e.g., Credit, Discount, Gift card, etc.

Reward Unit

times-solid.svg

The unit in which rewards are earned, e.g., Cash, Points, Months, etc.

Reward Value

times-solid.svg

The numeric value of the reward in its smallest measurement unit, e.g., for a cash reward of $1.00, the value would be 100 (cents).

Reward Name

times-solid.svg

The name you assigned to the reward when creating it in your program.

USD Value

times-solid.svg

The value of the reward in USD.

Program ID

times-solid.svg

The identifier of the program for which the reward was created.

Global Reward Key

times-solid.svg

Key of the global reward configuration in the reward catalog. This is under Rewards → Catalog → Create rewards → Reward Name.

Reward Source

times-solid.svg

How the reward was created, e.g., Manual, Referred user, Friend sign up.

Date Created

times-solid.svg

The date the reward was earned, formatted in milliseconds since unix epoch External Link.

Date Given

times-solid.svg

The date the reward was given, formatted in milliseconds since unix epoch External Link. (This value can differ from Date Created if the reward was pending).

Date Scheduled For

times-solid.svg

The date the reward was scheduled to be given to the user, formatted in milliseconds since unix epoch External Link.

Date Expires

times-solid.svg

The date after which the reward can no longer be redeemed, formatted in milliseconds since unix epoch External Link.

Date Cancelled

times-solid.svg

The date you cancelled the reward, formatted in milliseconds since unix epoch External Link.

Date Modified

times-solid.svg

The date you made modifications to the reward, formatted in milliseconds since unix epoch External Link.

Date Redeemed

times-solid.svg

The date the full reward was redeemed by the user, formatted in milliseconds since unix epoch External Link.

Assigned Credit

times-solid.svg

The amount in the base unit for Credit rewards. This is the equivalent of Reward Value, but for Credit rewards.

Redeemed Amount

times-solid.svg

The Value of the portion of the reward that was redeemed.

Fuel Tank Type

times-solid.svg

This can be either Credit or % discount.

Fuel Tank Code

times-solid.svg

This is like coupon code, e.g., SummerSave20, 20%OFF, etc.

Referred User ID

times-solid.svg

The user identifier of the referred friend.

Referred Account ID

times-solid.svg

The identifier of the referred friend's account.

referral.referredUser.id

times-solid.svg

Used in conjunction with Program ID to link a referral to a Program ID, if we want to attach a referral to a reward. This may not always match the User ID.

referral.referredUser.accountId

times-solid.svg

Used in conjunction with Program ID to link a referral to a Program ID, if we want to attach a referral to a reward. This may not always match the Account ID.

Validation error reference

You can get 3 types of validation errors:

  1. Inline error message: these appear in the preview validation table and cause error rows to be highlighted in red:

    • INVALID_FIELD — e.g., the Date Created field wasn't formatted in milliseconds since unix epoch External Link.

    • MISSING_FIELD — e.g., a required field such as User ID or Account ID is missing.

    Screenshot_2024-09-17_at_11_16_19_AM.png
  2. Error callout: these appear in place of the preview validation table as red warning messages:

    • MISSING_HEADER — e.g., a required column header such as Account ID or Reward Value is missing.

    • CSV_PARSING — e.g., the CSV file contains special characters that are improperly formatted.

    • FILE_REF_IO — e.g., the file is corrupted and can't be read.

    Screenshot_2024-09-17_at_11_17_20_AM.png
  3. Listed errors: these appear as a list of error counts on the Imports & Exports screen when the import type doesn't have a preview validation table. Row errors and file errors will display together:

    Screenshot_2024-09-10_at_10_58_19_AM.png

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.