[ "hello" ]

Welcome to the documentation for the chartbeat.com API.

Bugs/Feature Requests/Suggestions -> http://feedback.chartbeat.com/

Help/Discussion -> http://groups.google.com/group/chartbeat/

About this API

chartbeat.com allows full access to all real-time and historical data that it receives from your domain(s).  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 parsible in javascript.  To find out more about JSON, visit json.org/

To use this API, you need to first create api keys at chartbeat.com/apikeys and be an active subscriber of the chartbeat.com service.

Current API calls

Real-time API calls:

• histogram - Receive numerical data, summarized by ranges.
• 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.
• summary - Returns summary information about specific variables.
• summize - 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.
• 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.
• 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.
• twitterstats - Get the number of tweets for a domain's search terms.
• 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.

Example 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

Another place for examples are the site widgets, located here.

Other things to do

You can embed the dashboard widgets onto any other page.  This is different than the site widgets.  Embedding dashboard widgets

API Terms and Conditions

Please review the API Terms and Conditions before use