Skip to main content

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()

Release files for chartbeatpy 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chartbeatpy 0.2.1
File Size Uploaded
chartbeatpy-0.2.1.tar.gz 4.5 kB Details

Release files / chartbeatpy-0.2.1.tar.gz

Download URL chartbeatpy-0.2.1.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4da64fa08fc9eb59df2d792eee3a919503704aacc3f42f0e1fa4ec343907d081
BLAKE2b-256 checksum
How to use checksums
1b86f177460babaacc59f3d57b3e0566d5e358dbdfa9e60ea089b833e62e83cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page