https://github.com/segment-boneyard/geckoboard

Geckoboard API for node.
https://github.com/segment-boneyard/geckoboard

Last synced: about 5 hours ago
JSON representation

Geckoboard API for node.

• Host: GitHub
• URL: https://github.com/segment-boneyard/geckoboard
• Owner: segment-boneyard
• Created: 2014-03-07T19:49:32.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-11T20:26:32.000Z (almost 10 years ago)
• Last Synced: 2024-04-09T16:31:03.156Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 197 KB
• Stars: 22
• Watchers: 39
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# geckoboard

  [Geckoboard](http://www.geckoboard.com/) API for node -  push data to [custom widgets](http://www.geckoboard.com/developers/custom-widgets).

## Installation

    $ npm install segmentio/geckoboard

## Example

```js

var geckoboard = require('geckoboard')('api-key');

var widget = geckoboard('widget-id');

widget.number(100, function (err) {

    // ..

});

```

## API

#### Geckoboard(apiKey)(widgetId)

  Create a new Geckoboard widget.

#### #number(value, callback)

  Push a number `value` to the widget.

#### #percentageChange(current, previous, callback)

  Push a `current` and `previous` value for a percentage change widget.

#### #sparkline(values, callback)

  Push an array of number `values` to a sparkline widget.

#### #pie(map, callback)

  Push a `map` object mapping text to values to a pie chart widget.

#### #text(text, callback)

  Push `text` to a widget.

## License

MIT