npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

saiku-rest-api

v0.0.1

Published

A Node.js-based client for the Saiku Analytics JSON API

Downloads

4

Readme

A Saiku REST API client for Node.js

This is a client for the Saiku Analytics REST API. It is under active development, and should be considered beta software. More features are in development, and issues are welcome if you find something that doesn't work!

Purpose

This library is designed to make it easy for your Node.js application to request specific resources from Saiku. It uses a query builder-style syntax to let you craft the request being made to the Saiku endpoints, then returns the API server's response to your application as a JavaScript object.

Installation

To use the library, install it with npm:

npm install --save saiku-rest-api

Then, within your application's script files, require the module to gain access to it:

var Saiku = require('saiku-rest-api');

The REST API client requires Node.js version 0.10 or above.

Using the Client

The module is a constructor, so you can create an instance of the API client bound to the endpoint for your Saiku:

var Saiku = require('saiku-rest-api');
var saiku = new Saiku({ 
	host: 'http://localhost:8080',
	username: 'admin',
	password: 'admin'
});

Once an instance is constructed, you can chain off of it to construct a specific request.

We support requesting posts using either a callback-style:

// Callbacks
saiku.schemas().get(function(error, data) {
	if (!error) {
		// do something with the returned posts
	}
	else {
		// handle error
});

Contributing

Check CONTRIBUTING.md for more information.

History

For detailed changelog, see Releases.

Credits

I thank the following open source project:

  • Saiku UI - A user interface for the Saiku analytical tool (Apache license version 2).

License

MIT License © Breno Polanski