About this API

chartbeat is a real-time analytics service, which provides an interface for viewing what users on your site are doing right now, as well as providing historical context. The entire service is built on top of API's which you can use to access and repurpose the data we collect. You must be an active subscriber of chartbeat to use the API; sign up here.

We expose this data through a series of calls that return JSON.  We currently only return JSON data because it's simple, easily readible, concise, and easy to parse in Javascript.  To find out more about JSON, visit json.org/

All calls require an API key. You can obtain and manage your keys at chartbeat.com/apikeys.

Bugs/Feature Requests/Suggestions

http://support.chartbeat.com/

Help/Discussion

http://groups.google.com/group/chartbeat/

Common API Calls

Real-time API calls

• pages - An all inclusive API call that includes all data.  Only use this if you need access to all data.  If you just need a specific piece, please use a more specific API call.
• pathsummary - Return specified data about all paths (urls) on a domain.
• recent - Information about the most recent visitors to a page.
• quickstats - Summarizes the current state of an entire domain or domain + path.  The number of people on a page, reading, writing, idle, etc...
• toppages - Returns a list of pages, ordered by which ones have most visitors right now.

Historical API calls

• alerts - A list of alerts that have been fired for a given domain.
• snapshots - Historical data.  Returns a snapshot of what the real-time data was at a given timestamp.
• stats - Returns the min/max/avgs of historical data for the last month.
• data_series - Returns the value for a given measure (people, returning, reading, performance, a particular page or referrer, etc.) over a period of time.
• day_data_series - Returns the behavior of top pages or top referring domains over a given 24-hour period.

Other API Calls

Advanced real-time API calls

• histogram - Receive numerical data, summarized by ranges.
• summary - Returns summary information about specific variables. 

Deprecated historical API calls

• conversation - Given a search term, conversation returns a list of twitter posts and and blog comments matching the term. 
• snapdays - Historical data.  Returns a list of summary metrics for all days from a given timestamp. 
• twitterwords - Get or set the search terms for a specific domain.
• uptime - Historical data.  A minute by minute status of the availability of a given domain.

Use cases

You want to display how many people are on a page or your entire site -> summize

You want to display information about the last 10 visitors to your site -> recent

You want to show a graph of how long users have been on your site -> histogram

You want a summary of how many people are writing on each page -> pathsummary

You want to show your historical uptime information -> uptime

You want to keep a record of all the alerts sent to you -> alerts

Or you can use one of our pre-built site widgets, located here!

Examples

You can find example usage in our Labs examples and the source for our site widgets. 

API Terms and Conditions

Please review the API Terms and Conditions before use.