About this call
This call returns data from all API calls. Its main use is in the dashboard and should only be used if you need access to all the data at the same time. If you do not need all the data, there is most likely a more specific API call you can use. This call returns real-time data.
Format
http://api.chartbeat.com/pages/?host=[host]&path=[path]&apikey=[apikey]
- host - Required. The domain name to get all 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/pages/?host=chartbeat.com&apikey=abc123
Example return:
{
"active": [
{
"read": 14,
"write": 12,
"idle": 25,
"position": [
"0.0764"
],
"path": "/",
"total": 1.0
}
],
"referers": {
"": {
"": 1
}
},
"titles": {
"/": "Welcome to Chartbeat"
},
"summary": {
"newToPage": 0,
"return": 2,
"people": 92,
"read": 49,
"domload": 340,
"connspeed": 275,
"write": 31,
"idle": 12,
"new": 90
},
"recent": [
{
"count": "4",
"utc": 1232037424,
"domload": "4123",
"country": "US",
"longitude": -77.123498742699997,
"state": "write",
"referer": "",
"latitude": 38.815091639900003,
"path": "/",
"id": "b6jddonjydohljqk"
}
]
}
Return variables
There are five different arrays of data.
- active - The paths that currently have users on them.
- referrers - Sites that the current users have come from.
- titles - A map of path -> page title.
- summary - A summary of the current activity on the your website.
- recent - A list of the most recent visitors to the site.
All the variables above are described in the other API calls. Please refer to documentation for those calls for an explanation of them
Comments (0)
You don't have permission to comment on this page.