About this call

This routine provides summary data (refer to the summary API call), but for every path given a host.  This call returns real-time data.

Format

http://api.chartbeat.com/live/pathsummary/?host=[host]&keys=[keys]&types=[types]&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).
• jsonp - Optional.  Give the name of a function to wrap the return data in. Learn more here

Example

http://api.chartbeat.com/live/pathsummary/?host=chartbeat.com&keys=I,n,r&types=n,n,s&apikey=abc123

Example return:

{"/signup": {
                  "I": {
                        "data": {"nzObservations": 38.0,
                                 "max": 1.0,
                                 "sum": 38.0,
                                 "min": 0.0,
                                 "sumOfSquares": 38.0,
                                 "observations": 46.0
                                },
                        "type": "numeric"
                        },
                  "n": {"data": {"nzObservations": 0.0,
                                 "max": 0.0,
                                 "sum": 0.0,
                                 "min": 0.0,
                                 "sumOfSquares": 0.0,
                                 "observations": 1.0
                                 },
                        "type": "numeric"
                        },
                  "r": {"data": {"": 1},
                        "type": "string"
                       }
                 },
"/contact": {
                  "I": {
                        "data": {"nzObservations": 38.0,
                                 "max": 1.0,
                                 "sum": 38.0,
                                 "min": 0.0,
                                 "sumOfSquares": 38.0,
                                 "observations": 46.0
                                },
                        "type": "numeric"
                        },
                  "n": {"data": {"nzObservations": 0.0,
                                 "max": 0.0,
                                 "sum": 0.0,
                                 "min": 0.0,
                                 "sumOfSquares": 0.0,
                                 "observations": 1.0
                                 },
                        "type": "numeric"
                        },
                  "r": {"data": {"": 1},
                        "type": "string"
                       }
                 }
}

Return variables

Returns an associative array of each path and its respective data.

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