chartbeat-client

A node.js wrapper for the Chartbeat API.

Install

Install dot-filter using npm

$ npm install chartbeat-client --save

Usage

Import the library with require and initialize the client with your apiKey:

var CB = require("chartbeat-client");
 
var ChartbeatClient = new CB.createClient({
  apiKey: "317a25eccba186e0f6b558f45214c0e7"
});

Then call the available APIs passing to it the required parameters:

var params = {
    host: "gizmodo.com"
};
 
ChartbeatClient.quickstats(params)
    .then(function(data) {
        // do something
    })
    .catch(function(err) {
        // something went wrong
    });

Available APIs

Historical

Engagement Series

ChartbeatClient.engseries(params)

Engagement Stats

ChartbeatClient.engstats(params)

Social Series

ChartbeatClient.socseries(params)

Social Stats

ChartbeatClient.socstats(params)

Traffic Series

ChartbeatClient.trafseries(params)

Traffic Stats

ChartbeatClient.trafstats(params)

Live

For the Live APIs you can pass a version as second parameter, otherwise the latest available version will be used.

QuickStats

Versions: v3, v4

ChartbeatClient.quickstats(params, version)

Recent Visitors

Versions: v3

ChartbeatClient.recent(params, version)

Referrers

Versions: v3

ChartbeatClient.referrers(params, version)

Summary

Versions: v3

ChartbeatClient.summary(params, version)

Top Geo

Versions: v1

ChartbeatClient.top_geo(params, version)

Top Pages

Versions: v3

ChartbeatClient.toppages(params, version)

Developed By

Enrico Candino - www.enricocandino.it

Forked from: node-chartbeat

License

The MIT License (MIT)

Copyright (c) 2015 Enrico Candino

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.