Skip to main content

A charbeat API wrapper.

Project description

A simple, synchronous charbeat API wrapper. This python package creates a simple “pythonic” entry point for the Chartbeat API. Originally created by Timothee Peignier, we are adapting it to our needs here at Detroit Media Partnership.

Any requests, issues should be directed towards us in this forked repository, or email me at neurosnap@gmail.com

Chartbeat API Explorer

Installation

To install charbeatpy, use pip:

$ pip install chartbeat

or

$ python setup.py install

Quick How To

from chartbeatpy import Chartbeat

beat = Chartbeat("<your chartbeat api key>", "<your host>")
# live data
beat.quickstats()
beat.geo()
# some API endpoints require extra parameters
beat.histogram(keys=[user,title], breaks=[1,2,10])
beat.path_summary(keys=[pagetimer, time_spent, new])
beat.summary(keys=[domain, title, read, write, idle])
beat.recent()
beat.referrers()
beat.top_pages()

# historical data
beat.engage_series()
beat.engage_stats()
beat.social_series()
beat.social_stats()
beat.traffic_series()
beat.traffic_stats()

# specify API version number
oldbeat = Chartbeat("<API>", "<host>", 2)
oldbeat.quickstats()

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for chartbeatpy, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size chartbeatpy-0.2.1.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page