joola.io.sdk

joola.io's software development kit (SDK)

npm install joola.io.sdk
46 downloads in the last day
52 downloads in the last week
71 downloads in the last month

joola.io.sdk Build Status Gitter chat

API Docs joola.io Docs Issues Contributing About
i2 i1 i6 i4 i5

joola.io logo

joola.io.sdk is a Software Development Kit (SDK) responsible for communication between a client using the SDK and the joola.io server. If you don't have a joola.io server running yet, get one up and running in minutes or open a free account with free.joola.io.

The SDK can consume ANY endpoint of the joola.io framework, however for brevity purposes, the API manual below includes only the main topics of:

  • Pushing data is done by sending an array of JSON documents for storage in joola.io cache.
  • When Querying, you describe the data you wish to consume and shape it to your liking.
  • Transform your data into insight using Data Visualization.

Getting the SDK

Option 1: Include joola.io.sdk in your HTML.

<script src="http://localhost:8080/joola.io.js"></script>
<script>
  console.log(joolaio.VERSION);
</script>

Optional: if you'll include ?APIToken=XXXXXX, you'll be able to use joola.io.sdk without calling init.

Option 2: Require the SDK require('joola.io.sdk');

$ npm install http://github.com/joola/joola.io.sdk/tarball/develop
var joolaio = require('joola.io.sdk');
console.log(joolaio.VERSION);

Quick Example

<!DOCTYPE html>
<html>
<head></head>
<body>

<div id="metric-visits"></div>

<script src="http://localhost:8080/joola.io.js?APIToken=12345"></script>
<script>
  joolaio.events.on('ready', function () {
    joolaio.beacon.insert('visits', {username: 'thisisme', visits: 1});
    new joolaio.viz.Metric({
      container: '#metric-visits',
      query: {
        timeframe: 'last_hour',
        interval: 'minute',
        dimensions: [],
        metrics: ['visits']
      }
    });
  });
</script>
</body>
</html>

Learn more about using the SDK

Contributing

We would love to get your help! We have outlined a simple Contribution Policy to support a transparent and easy merging of ideas, code, bug fixes and features.

If you're looking for a place to start, you can always go over the list of open issues, pick one and get started. If you're feeling lost or unsure, just let us know.

Contact

Contacting us is easy, ping us on one of these:

License

Copyright (c) 2012-2014 Joola Smart Solutions. GPLv3 Licensed, see LICENSE for details.

npm loves you