About this call

---

 

Summary is a generic routine that provides either numeric or categorical summaries of event fields given a host and optional path. Numeric summaries include min, max, sum, nonzero observations, observations and sum of squares. Categorical summaries include field keys with associated counts.  This call return real-time data.

 

Format

---

 

http://api.chartbeat.com/summary?host=[host]&keys=[keys]&types=[types]&path=[path]&apikey=[apikey]   

 

• host - Required.  The domain name to get summary data about.

• apikey - Required.  An api key generated here that gives access to this call.

• keys - Required.  A comma separated list of keys.  The keys represent what data to return.  Learn more about keys here.

• types - Required.  How to return the key data, either n or s (numeric or string).

• 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/summary?host=chartbeat.com&keys=I,n,r&types=n,n,s&apikey=abc123

Example return:

 

{

"I": {

"data": {

"nzObservations": 103.0,

"max": 2.0,

"sum": 103.0,

"min": 0.0,

"sumOfSquares": 103.0,

"observations": 126.0

},

"type": "numeric"

},

"n": {

"data": {

"nzObservations": 19.0,

"max": 2.0,

"sum": 19.0,

"min": 0.0,

"sumOfSquares": 19.0,

"observations": 126.0

},

"type": "numeric"

},

"r": {

"data": {

"": 28,

"http://referer.somesite.com": 12,

"http://anotherreferer.com": 3

},

"type": "string"

}

}

Return variables

---

 

Returns a list of objects corresponding to the given keys.

 

For a list of what the short variable letters stand for, please refer to this list.