| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!

View
 

snapdays

Page history last edited by Eytan Daniyalzade 11 years, 11 months ago

About this call


 

Returns a list of snapshots for days since the given time.  The snapshots returned are not full snapshots.  They are limited to the metrics defined below.  This call returns historical data.

 

Status: Deprecated


We are in the process of deprecating this API endpoint in favor of a new one. We will have a new endpoint ASAP, and have remove support for this endpoint shortly after.

 

Format


 

http://api.chartbeat.com/historical/dashapi/snapdays/?host=[host]&api=pages&since=[timestamp]&apikey=[apikey]
 
 
 
  • host - Required.  The domain name to get limited snapshots about.
  • since - Required.  Unix timestamp.  Returns all limited snapshots since this time.
  • apikey - Required.  An api key generated here that gives access to this call.
  • jsonp - Optional.  Give the name of a function to wrap the return data in. Learn more here

 

Example


 

http://chartbeat.com/dashapi/snapdays/?host=chartbeat.com&api=pages&since=1231194225&apikey=abc123

 

Example return:

 

{
"2009-01-05": {
"return": [20, 17, 18],
"people": [24, 20, 24],
"read": [4, 1, 4],
"domload": [433, 243, 380],
"snaptime": [  "2009-01-05 00:00",
"2009-01-05 00:05",
"2009-01-05 00:10"
],
"write": [2, 0, 2],
"idle": [18, 19, 18],
"new": [4, 3, 6]
},
"2009-01-06": { /* data like above */ }
}
 
 
 
 

Return variables


 

Returns an associative array, keyed on the day.  Each day is broken down into eight arrays.  Each item in the eight arrays all correspond with each other (so read[0] and new[0] and snaptime[0]... all correspond).

 

This call returns data for every five minutes.  The example has been truncated for easy reading.

 

  • new - The number of new people on the entire domain.
  • return - The number of returning people on the entire domain.
  • people - The total number of people on the entire domain.
  • 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.
  • snaptime - The time that the data was recorded. 

Comments (1)

jameshd said

at 11:31 am on Mar 15, 2010

if you're using 100% javascript with Date().getTime() and this call is returning an empty set, divide your timestamp by 1000. Javascript timestamps are somewhat longer than php/pythons.

You don't have permission to comment on this page.