About this call

Give an overview summary of the people on your domain right now.  This call returns real-time data.

Format

http://api.chartbeat.com/summize?host=[host]&path=[path]&apikey=[apikey]

• host - Required.  The domain name to get summize data about.
• apikey - Required.  An api key generated here that gives access to this call.
• path - Optional.  Give a specific path.  If not given, data is from all paths. (Example, the path of http://chartbeat.com/signup/ is /signup/)
• jsonp - Optional.  Give the name of a function to wrap the return data in. Learn more here

Example

http://api.chartbeat.com/summize?host=chartbeat.com&apikey=abc123

Example return:

{

"newToPage": 10,

"referers": {

"": { "": 7 }

"refsite.com": {"/referring/path/on/refsite": 3}

},

"return": 1,

"domload": 0,

"read": 1,

"people": 1,

"idle": 0,

"write": 0,

"connspeed": 27,

"new": 0

}

Return variables

Returns an object with summize variables.

• newToPage - People that are new to the specific page(s).
• referers - Referring sites that got the current users to your site.  "" stands for direct access to the site, with no referrer.
• return - Number of users that have returned.
• new - Number of users that are new.
• connspeed - The average connection speed of the users.
• read - The number of people reading (defined as actively moving around the page).
• write - The number of people writing (defined as actively typing on the page).
• idle - The number of people idle (defined as no activity for a few minutes).
• domload - The average time it took for users to download and render the page.
• people - The total number of people.

•  

      

Note:  This call is really just a call to summary, with the variables "n,R,W,I,q,r", "n,n,n,n,n,s".  Please refer to summary to further understand those variables.