SaaSquatch Help Center

The SaaSquatch portal provides a quick and easy way to import events within our system.

🔗 Importing an Event

Imported events link to a user and can trigger both conversion and non-conversion goals.

  1. Head to your SaaSquatch account.
  2. In the upper right corner of your SaaSquatch account select either your Live or Test tenant.
  3. Click "Analytics" in the upper header of your SaaSquatch account.
  4. Select the "Reports" tab in the secondary header.
  5. Click "Import" on the right side of the Your Reports page.
  6. Select "User Events" from the Import Type.
  7. Click "Select & Upload" and choose the file to import.
  8. Click "Start Import" to begin the import.
  9. When the import completes a confirmation email is sent.

Event imports may take up to 30 minutes depending on queue and file size.

🔗 Upload Format & Recommendations

  • SaaSquatch accepts event imports submitted in .csv or .jsonl file formats.
  • Fields are case sensitive
  • It is recommended that each import does not exceed 500,000 entries.
  • Please reference our sample CSV file and sample JSONL file.

🔗 Standard Fields

Field Type Description
accountId Required string The unique identifier of the Account that this user belongs to.
userId Required string The unique identifier provided for this user.
event.key Required string The unique identifier for the type of event. EX: purchase or refund.
event.dateTriggered integer The timestamp in milliseconds when this event was triggered.
event.fields object A collection of fields with event specific information.

🔗 Event Fields

Events sent to SaaSquatch can contain a wide array of fields. This includes event specific information to interface with programs and third party integrations.

For example, a 'purchase' event would have 'revenue' and 'currency' fields.

When importing an event using .csv, these fields would be represented as: event.fields.revenue and event.fields.currency.

🔗 Add more Event Fields

To add more fields to an imported event, use the following format:

CSV: event.fields.yourEventFieldName

JSON: "event":{ "key":"yourEventKey", "fields":{"yourEventFieldName":"yourEventFieldValue"}}

🔗 Results

When your import completes you will receive an email notifying you of the result.

The results of the import are also available for download from the Import and Export Jobs page within the Reports section in the SaaSquatch portal.

Please Note: Download links will expire after 30 days.

🔗 Successful Upload

If the import completes successfully, a file with the event information of those that were successfully imported will be generated and emailed to you.

The file will contain the following fields.

Field Type Description
user.accountId string The unique identifier of the Account that this user belongs to.
user.id string The unique identifier provided for this user.
event.id string The unique identifier given to the event created in SaaSquatch.
event.key string The unique identifier for the type of event. EX: purchase or refund.
event.dateTriggered integer The timestamp in milliseconds when this event was triggered.
event.dateReceived integer The timestamp in milliseconds when SaaSquatch received this event.
event.dateProcessed integer The timestamp in milliseconds when SaaSquatch processed this event.
event.fields object The collection of fields containing event specific information.

🔗 Errors

If any non-fatal errors are encountered during the import, then a second results file will also be generated (in addition to the file with the successfully uploaded records). The errors file includes entries for each error that occurred, including the row number of the record (from the initial import file) that failed, and any associated error messages:

recordNumber message apiErrorCode statusCode
2 This request requires a valid non-empty id BAD_REQUEST 400

Please contact support@referralsaasquatch.com for additional questions.