dashboards-helpscout v0.2.0

dashboards-helpscout

A Helpscout plugin for segmentio/dashboards.

Use this plugin to visualize your active ticket count, and who is behind on their tickets.

Installation

$ npm install dashboards-helpscout

Example

var Dashboards = require('dashboards');
var helpscout = require('dashboards-helpscout');

new Dashboards()
  .use(helpscout('apiKey', 'mailbox-id'));
  .run();

Metrics

The metrics exposed by this plugin are:

• helpscout.total active tickets
• helpscout.total tickets yesterday trailing average
• helpscout.total tickets 0-1 weeks ago
• helpscout.total tickets 1-2 weeks ago
• helpscout.total active tickets by owner
• helpscout.oldest ticket time
• helpscout.oldest ticket owner
• helpscout.oldest ticket shaming

Quickstart

Here's a full example of a Geckoboard dashboard showing support dashboards:

var Dashboards = require('dashboards');
var helpscout = require('dashboards-helpscout');
var pipe = require('parallel-ware-pipe');
var geckoboard = require('geckoboard')('api-key');

new Dashboards()
  .use(helpscout('apiKey', 'mailbox-id'))
  .use(pipe('helpscout.total tickets yesterday trailing average', geckoboard('widget-id').number))
  .use(pipe('helpscout.total active tickets', geckoboard('widget-id').number))
  .use(pipe('helpscout.total active tickets by owner', geckoboard('widget-id').pie))
  .use(pipe('helpscout.oldest ticket shaming', geckoboard('widget-id').text))
  .run();

License

MIT