https://github.com/segment-boneyard/metrics-helpscout

Visualize your Helpscout activity on a dashboard
https://github.com/segment-boneyard/metrics-helpscout

Last synced: about 5 hours ago
JSON representation

Visualize your Helpscout activity on a dashboard

• Host: GitHub
• URL: https://github.com/segment-boneyard/metrics-helpscout
• Owner: segment-boneyard
• Created: 2014-03-07T22:04:53.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-05-25T07:07:05.000Z (over 10 years ago)
• Last Synced: 2024-09-19T02:40:01.983Z (about 2 months ago)
• Language: JavaScript
• Size: 180 KB
• Stars: 12
• Watchers: 40
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# metrics-helpscout

A [Helpscout](https://www.helpscout.net/) plugin for [segmentio/metrics](https://github.com/segmentio/metrics).

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

![](https://f.cloud.github.com/assets/658544/2361183/33c4df78-a62e-11e3-9921-6591e787e43e.png)

## Installation

    $ npm install metrics-helpscout 

## Example

```js

var Metrics = require('metrics');

var helpscout = require('metrics-helpscout');

new Metrics()

  .every('30m', helpscout('apiKey', ['mailbox-id']));

```

## Metrics

The metrics exposed by this plugin are:

Total active:

- `helpscout active tickets` - the total number of active tickets in teh mailboxes

Weekly:

- `helpscout tickets modified avg` - the trailing average of tickets modified in the last 7 days

- `helpscout tickets modified last week` - tickets modified in the last 7 days

- `helpscout tickets modified 2 weeks ago` - tickets modified 2 weeks ago

- `helpscout tickets created avg` - trailing average of tickets created in the last 7 days

- `helpscout tickets created last week` - tickets created in the last 7 days

- `helpscout tickets created 2 weeks ago` - tickets created two weeks ago

By Owner:

- `helpscout active tickets by owner` - active tickets by owner

```js

{

    "steve": 14,

    "mark": 3

}

```

Oldest Ticket:

- `helpscout oldest ticket time` - the javacript date of the oldest ticket

- `helpscout oldest ticket owner` - the owner of the oldest ticket

- `helpscout oldest ticket timeago` - the timeago string of the oldest ticket

- `helpscout oldest ticket shaming` - Example: "Bob: 2 days of no response"

Winners:

- `helpscout first place owner` - the person who closed the most tickets today

- `helpscout first place closed` - the winning number of tickets

- `helpscout second place owner` - the second place person

- `helpscout second place closed` - the second winning number of tickets

- `helpscout tickets closed today by owner` - tickets closed today by owner

```js

{

    "devin": 23,

    "randy": 15

}

```

## Quickstart

Here's a full example of a [Geckoboard](https://github.com/segmentio/geckoboard) dashboard showing support metrics:

```js

var Metrics = require('metrics');

var helpscout = require('metrics-helpscout');

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

Metrics()

  .every('10m', helpscout('apiKey', 'mailbox-id'))

  .use(function (metrics) {

    metrics.on('helpscout tickets modified avg', geckoboard('widget-id').number);

});

```

## License

MIT