Purser

A lightweight JavaScript library for preserving user data from first website visit to signup.

Usage

The library stores data such as utm_medium, landing_page and referrer in a localStorage object, and makes the object available via a handy API with the following methods:

purser.create() // automatically called on first website visit
purser.fetch() // returns the object
purser.convert(obj) // returns the object updated with conversion data
purser.update(obj) // lets you add additional parameters to the object
purser.destroy() // removes the object from localStorage

~~ NEW in version 1.1.0: track visits and pageviews ~~
purser.visits.create() // adds a visit instance to the object, called automatically if has been over 30 minutes since the most recent visit.
purser.visits.all() // returns an array of all visits
purser.visits.fetch(id) // Fetch a specified visit
purser.visits.update(id, obj) // Update a specified visit with data in an object
purser.visits.delete(id) // Delete a specified visit

View a live example at http://purser.herokuapp.com/.

Installation

git clone https://github.com/bilbof/purser

Add purser.min.js to every page on your website. When a visitor creates an account, call purser.convert(obj) and add the user to your CRM/ChartMogul with attributes returned.
When a visitor creates an account, call purser.convert(obj) to get the visitor's marketing attributes
Add the user's marketing attributes to them in your CRM or app

Example

See an example at http://github.com/bilbof/purser/example.

Code example

<script src="purser.js"></script>
<script>
  $('.red-signup-button').click(function(){

      var attributes = purser.convert({
        signup_button: "red-signup-button"
      });

      // here send the customer object to your CRM/app with their attributes
  });
</script>

The attributes object in the example above would look something like this:

{
	"first_website_visit": "2017-08-10T17:52:18.088Z",
	"referrer": "www.google.co.uk",
	"browser_timezone": 0,
	"browser_language": "en-GB",
	"landing_page": "http://localhost:5000/product",
	"screen_height": 800,
	"screen_width": 1280,
	"utm_medium": "google_search_ads",
	"utm_source": "google",
	"sign_up_button": "green-button",
	"converted_at": "2017-08-10T17:52:41.981Z",
  "visits_at_conversion": 12,
  "pageviews": 17,
  "last_visit": "2017-08-10T17:45:00",
  "visits": [<array of visit objects>],
	"conversion_page": "http://localhost:5000/signup"
}

Contributing

If you would like to contribute, PLEASE DO! Just create a Pull Request once you've made your changes.

Want a feature added, but would prefer not to do it yourself? Create an Issue.