priviametrics: A Ruby repository from mkolenda

priviametrics is a Javascript module that exposes a single function:

priviametrics.track(name, {property_1: "some value"}, {property_2: "some other value"});

To start logging events from your site to Priviametrics follow these steps:

In the head section of your web page include this JavaScript file.

For example

<head>
   <script src="//priviametrics.herokuapp.com/assets/priviametrics.js"></script>
   ...other tags...
</head>

Call the priviametrics.track() function when appropriate.

Some examples:

On a sale - Let's assume you want to save a sale event on your website. On the sale confirmation page you could call the priviametrics.track method and pass in the sale amount information.

With Javascript

document.onreadystatechange = function () {
    if (document.readyState == "complete") {
        var order_amount = 130;
        var order_quantity = 5;
        priviametrics.track('SALE', order_amount, order_quantity);
    }
};

With JQuery

$(document).ready(function() {
     var order_amount = 130;
     var order_quantity = 5;
     priviametrics.track('SALE', order_amount, order_quantity);
});

Perhaps you want to track when a user clicks the Checkout button on your site. Let's assume the button has an ID #checkout and the order total and order quantity are input fields with ID's of #total and #quantity respectively. You can assign the priviametrics.track() method to the click event of the button and pass in the current values of #total and #quantity.

Here are a few ways you can do that.

With Javascript

document.onreadystatechange = function () {
    if (document.readyState == "complete") {
        document.getElementById("checkout").onclick = function () {
            priviametrics.track('CHECKOUT',
                {property_1: document.getElementById('total').value},
                {property_2: document.getElementById('quantity').value}
            );
        }
    }
};

With JQuery

$(document).ready(function() {
    $("#checkout").on("click", function() {
        priviametrics.track('CHECKOUT', {property_1: $('#total').val()}, {property_2: $('#quantity').val()});
    });
});

See your data at http://priviametrics.herokuapp.com.

Log in with the administrator user: admin@test.com.
Or use the standard user user@test.com. Both have the same password: 'password'

Enjoy!

mkolenda/priviametrics