saasco-sdk v0.1.14

Saasco is a platform of saas apps where members only pay the infrastructure cost of what they use. As a result Saasco apps are up to 99% cheaper than traditional saas products.

• Privacy
• Getting Started
• Init Automatic Page View Tracking
• Tracking Events
• Identifying Users
• Debugging and Dev
• Reserved Properties

🔒 Privacy

By default Saasco is privacy friendly, using no cookies and obscuring all activity behind Anonymous IDs. However if you want to power more complex user tracking you can identify users and then all events they do will be attributed to them in your CRM. This can assist with customer support but also for things like drip campaigns and other marketing activities.

Getting Started

Install by running: npm install saasco-sdk

Copy your Project ID from the project settings page in Saasco: https://saasco.com/your-project/settings/project

Then import Saasco and initiate the lib with your Project ID.

// lib/saasco.ts
import { Saasco } from 'saasco-sdk';

export const saasco = new Saasco({ projectId: 'YOUR-PROJECT-ID' });

Init Automatic Page View Tracking

When you initiate the lib Saasco will automatically start tracking all page views in your app. There is no other configuration. It will automatically track url changes, even for SPAs like NextJs and Vue. You can also manually track pages by opting out of automatic page tracking. For most use cases you don't need to do this.

// ./app/index
import saasco from './lib/saasco';

// This should be called once in your app and will start auto page tracking if you have it enabled.
saasco.init();

Tracking Events

With events you can track custom actions users are taking on your site with event properties.

Each event has 2 components:

Name - this is the name of the action that was taken.

We like to follow segments Object Action Framework for naming events.

Properties - This is an object with the values of the event. Such as a the value, currency, or query.

We currently have limited support for properties, but in the future we will support complex querying and actions based on event properties.

// Import saasco
import { saasco } from '../lib/saasco.ts';

// Track an event
saasco.track("Searched Movies");

// Track an event with properties
saasco.track("Searched Movies", {
	query:"batman",
	sortBy:"relevancy"
});

Identifying Users

By default Saasco does not track any identifiable data about users, just anonymous user ids and session ids. However if you want to tie events to users you can identify users which will connect events to users in your CRM and power tools like drip campaigns and customer support.

To do this just identify a user with their DistinctId (usually the user ID from your database) and then any properties on the user.

// Import saasco
import { saasco } from '../lib/saasco.ts';

// Inside your user logged in function identify a user
// You should only identify users when they login, or their properties change
function signedIn(){
	// Identify a user
	saasco.identify("USER-ID-FROM-YOUR-DB", {
		// Any user properties you want to record with the user
		name:"Tony Hawk",
		email:"tony@xgames.com",
		bestTrick: 900
	});
}

// When a user logs out you can unidentify by identify null
function signedOut(){
	saasco.identify(null)
}

Identifying users who don't have an ID

Often times you have a users contact details before they sign up for your site. This could be part of the signup flow, or if they were to subscribe to marketing emails before they sign up as a customer

Saasco allows identifying users without an id by simply skipping the ID part of the identify call. This will add contacts to the CRM for email marketing and other tools before users register.

For example:

// Identify a user only by their email
saasco.identify({
    name:"Tony Hawk",
    email:"tony@xgames.com",
    bestTrick: 900
});

By doing this users will get tracked and added to your contacts, and as soon as they do login, assuming they use the same email address, all their properties will be connected.

Soft vs Full identify

When users are identified without a ID we call this is a "Soft Identify". Users who are soft identified can also be called "Leads". Once a user signs up and you identify them with an ID they will be fully registered and can be called "Customers"

In the CRM when you identify a user, either soft or full, they become a contact. The type of the contact depends on whether they were fully identified, "Leads" are soft and "Customers" are full.

Debugging and Dev

When setting up Saasco analytics you probably want to exclude your local environment.

To do so simply turn on dev mode.

export const saasco = new Saasco({
    projectId: 'YOUR-PROJECT-ID',

    // use an env to only set enabled to true on production
    enabled: process.env['NODE_ENV'] === 'production',
});

Debugging

You can turn on debugging when you initiate the repo or by running saasco.debug(true) in your code or the browser.

export const saasco = new Saasco({
    projectId: 'YOUR-PROJECT-ID',
    enabled: process.env['NODE_ENV'] === 'production',
    // Set to true to console log analytics events.
    // This works even when enabled is false - it just wont send the data
    debug: true,
});

You can also enable debug mode by calling saasco.debug(true) anywhere in your code.

saasco.debug(true);
// will console log "debug mode activated"

Reserved Properties

Saasco has reserved some properties that have semantic meanings for contacts and, and will handle them in special ways. For example, Saasco always expects email to be a string of the user’s email address, this is important for when sending emails using the marketing app. The SDK will do its best to match these properties, eg (created_at will be mapped to createdAt), but if possible you should use the reserved properties.

Reserved Contact Properties

Default Contact Properties

Our SDKs automatically collect certain properties on every event or user profile. Any property that starts with $ is a property that has been generated by the SDK or ingestion.

Reserved Integration Properties

Reserved event properties

Properties used to calculate revenue for different traffic sources and LTV for users.

Default Event Properties

Our SDKs automatically collect certain properties on every event or user profile. The default properties begin with a $ and can be overwritten with your own identify calls, so we recomend avoiding leading $ in your identify call properties to avoid conflicts.

Reserved Events with Optional Properties

⚠️ The event schema described below is not yet implemented in the UI. However, if you wish to future-proof your implementation, you can start using this schema in anticipation of its integration.

Reserved events are common events that happen during the lifecycle of a user, with optional properties to capture more detailed information, including revenue data where appropriate.

• Signed Up
• Signed In
• Signed Out
• Trial Started
• Trial Completed
• Payment Completed
• Subscription Started
• Subscription Cancelled
• Subscription Upgraded
• Subscription Downgraded

Signed Up

Event triggered when a user signs up. | Property | Description | |----------|----------------------------------| | source | How the user found your site. | | value | Track an estimated value of the signup|

Example:

saasco.track('Signed Up', {
  source: 'Referral by friend',
});

Signed In

Event triggered when a user signs in. | Property | Description | |----------|--------------------------------------------------| | method | The method used for signing in (e.g., email, social media). |

Example:

saasco.track('Signed In', {
  method: 'email',
});

Signed Out

Event triggered when a user signs out. No optional properties.

Example:

saasco.track('Signed Out');

Trial Started

Event triggered when a user starts a trial. | Property | Description | |-------------------|---------------------------------------------------------------------| | duration | The duration of the trial in days | | type| Values can be optIn for then the user didn't provide a cc or optOut when the user provided a cc and it will automatically start and the end of the trial period|

Example:

saasco.track('Trial Started', { duration: 14, type: 'optOut' });

Trial Completed

Event triggered when a user successfully completes a trial. | Property | Description | |-------------------|---------------------------------------------------------------------| | daysLeftInTrial| If a user manual upgrades before the end of the trial you can record this here|

Example:

saasco.track('Trial Completed', { daysLeftInTrial: 4 });

Payment Completed

Event triggered when a payment is completed. This is may be called on the server side after a confirmation webhook. This is helpful for recording ongoing subscription payments.

Example:

saasco.track('Payment Completed', { revenue: 29.99, currency: 'GBP' });

Subscription Started

Event triggered when a user starts a subscription. If you have integrated with stripe for revenue tracking or are doing server side revenue tracking with webhooks you should skip the revenue and currency properties to prevent duplicate revenue tracking.

Example:

saasco.track('Subscription Started', {
  plan: 'Monthly',
});

Subscription Cancelled

Event triggered when a subscription is cancelled.

Example:

saasco.track('Subscription Cancelled', {
  reason: 'Not using it any more',
});

Subscription Upgraded

Event triggered when a subscription is upgraded. | Property | Description | |-----------------|-----------------------------------------------------------------------------------------------| | fromPlan | The previous plan. | | toPlan | The new plan. | | previousRevenue | The revenue from the previous plan. | | newRevenue | The revenue from the new plan. | | revenue | If the customer is charged immediately then include a revenue number here | | currency | The currency of the payment, assumed to be USD unless otherwise specified. |

Example:

saasco.track('Subscription Cancelled', {
  fromPlan: 'Monthly',
  toPlan: 'Annual',
  previousRevenue: 29,
  newRevenue: 129,
});

Subscription Downgraded

Event triggered when a subscription is downgraded. | Property | Description | |------------|-------------------| | fromPlan | The previous plan. | | toPlan | The new plan. | | previousRevenue | The revenue from the previous plan. | | newRevenue | The revenue from the new plan. | | revenue | If the customer is refunded immediately then include a revenue number here, in the case of a downgrade this will be a negtive value. Only include the revenue here if it's not tracked on your backend or with a webhook | | currency | The currency of the payment, assumed to be USD unless otherwise specified. |

Example:

saasco.track('Subscription Cancelled', {
  fromPlan: 'Annual',
  toPlan: 'Monthly',
  previousRevenue: 129,
  newRevenue: 29,
  revenue: -36,
  currency: 'USD',
});

Use the hosted SDK

To use the hosted JS SDK, add the following script to your HTML header: All properties should be added as data attributes in the format data-prop name

<script
  src="https://saasco.com/sdk/saasco-sdk.js"
  data-projectId="YOUR-PROJECT-ID"
></script>

All the properties for initiating the sdk can be passed in like this:

<script
  src="https://saasco.com/sdk/saasco-sdk.js"
  data-projectId="YOUR-PROJECT-ID"
  data-debug="true" // pass any properties as data params
></script>

You can then call the track and identify methods like so:

saasco.track('Searched Movies');

For type safety in your TypeScript project, you can use the following in an index.d.ts file

import { Saasco } from 'saasco-sdk';

declare global {
  interface Window {
    saasco?: Saasco;
  }
}