Naughty Program Manipulator
    Have ideas to improve npm?Join in the discussion! »

    cumulio

    1.0.1 • Public • Published

    Cumul.io API

    You can use this Node.js module to interact with the Cumul.io API in order to create, modify or delete datasets, dashboards or push new data into the platform in a programmatic way.

    Installation

    npm install cumulio

    Usage

    Include the cumulio npm package in your project. For example, to push data into the platform (triggering real-time dashboard updates):

    var Cumulio = require('cumulio');
    
    // Connect
    var client = new Cumulio({
      api_key: '< your API key >',
      api_token: '< your API token >'
    });
    
    client.create(
      'data',
      {
        securable_id: '< dataset identifier >',
        data: [
          ['plaice', 2014, 2.1234, 751],
          ['plaice', 2015, 1.8765, 573]
        ]
      })
      .then(function() {
        console.log('Success!');
      })
      .catch(function(error) {
        console.error('API error:', error);
      })
      .finally(function() {
        client.close();
      });
    

    See example-embedding.js for an example of how to use the API to securely embed dashboards in a web page (with serverside pre-filtering of the data that the end-user can query).

    Documentation

    The API documentation (available services and methods) can be found here.

    Keywords

    none

    Install

    npm i cumulio

    DownloadsWeekly Downloads

    433

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    16.6 kB

    Total Files

    6

    Homepage

    cumul.io

    Last publish

    Collaborators

    • avatar