Utilisation de l'API cliente

Connecter un client:

var client = new SidLeeClient('https://sidlee.herokuapp.com/', function(data) {
	console.log(data);
});

La fonction passée en callback est appelée à chaque fois qu'une nouvelle mesure est reçue.

Requeter les mesures du jour

client.today().exec(function(data) {
	console.log(data);
});

data retourne un objet contenant une vue aggrégée des évènements ayant eu lieu ce jour. Voici un exemple de la structure retournée:

[
	{
		"_id": "visits",
		"value": 2
	},
	{
		"_id": "likes",
		"value": 86818
	},
	{
		"_id": "undo",
		"value": 160,
		"date": "DATE_OF_LAST_EVENT",
		"app": "my app",
		"user": "user"
	}
]

Pour chacun des capteurs, et API interrogées, le client renvoie un doublet contenant le nom de l'event et une valeur represantant soit la moyenne, soit la somme des données mesurées pour l'event. undo est un cas particulier car il renvoie aussi le dernier undo (date, app et user).

La liste des capteurs et API est disponible ici.

Requeter les mesures des dernières 24h

client.last24().exec(function(data) {
	console.log(data);
});

data retourne un objet contenant une vue aggrégée des évènements ayant eu lieu lors des dernières 24 heures, triées par tranches horaire. Voici un exemple de la structure retournée:

[
	{
		"_id": "red",
		"values": [
			{
				"hourAgo": 0,
				"value": 1
			},
			{
				"hourAgo": 12,
				"value": 5
			},
			{
				"hourAgo": 17,
				"value": 14
			},
			{
				"hourAgo": 18,
				"value": 2
			},
			{
				"hourAgo": 21,
				"value": 12
			},
			{
				"hourAgo": 22,
				"value": 2
			}
		]
	},
	...
]

Retourne soit une somme, soit une moyenne heure par heure des relevés des capteurs. Le format horaire est un format "hour ago", c'est à dire que dans l'exemple ci-dessus, il y a eu un event "red" dans l'heure en cours, 5 events "red" 12h plus tôt, etc.

Requeter les mesures des derniers 30 jours

client.last30().exec(function(data) {
	console.log(data);
});

Idem à last 24, mais la somme ou la moyenne est journalière. En lieu et place de hourAgo, ce sera dayAgo.

Requeter les anciennes mesures

client.events().exec(function(data) {
	console.log(data);
});

events accepte un argument optionnel permettant de filtrer par nom d'évènement. Chaque capteur aura son nom d'évènement, ainsi on peut filter par nom:

client.events('test').exec(function(data) {
  console.log(data);
});

On peut aussi filtrer par date avec from et to:

client.events('random')
		.from('2014-12-01')
		.to('2014-12-02')
		.exec(function(data) {
			console.log(data);
		});

Cela retournera les mesures du capteur 'random' entre les dates du 1er décembre et du 2 décembre.

Enfin, il est possible de limiter le nombre de résultats avec limit:

client.events('random')
		.from('2014-12-01')
		.to('2014-12-02')
		.limit(10)
		.exec(function(data) {
			console.log(data);
		});

Comme l'exemple précédent, mais ne retournant que 10 résultats.

Il s'agit d'une api utilisant le pattern de fluent interface, cela veut dire qu'il est possible de chainer les fonctions, mais il ne faut pas oublier d'appeler exec pour effectivement éxecuter la requête.

Un exemple sur jsfiddle: http://jsfiddle.net/07acad0b/