Reporting: Summary (v1)

Overview
Note: This version of the reporting API has been deprecated, please migrate to v2.

Utilization summary data can be retrieved from the API by issuing a GET request to the following resource(s).

GET /api/v1/reports/dashboard/sources.json

GET /api/v1/reports/dashboard/applications.json

GET /api/v1/reports/dashboard/hosts.json

Usage
The following parameters are passed to this resource as a query string.

filter: Specify a URL encoded filter. The filter parameter should be used as described in the Filtering Sinefa Reports article (optional).

e.g. &filter=instance+%3d+London

start: A time-stamp representing the start of the range to query in milliseconds since epoch (required).

end: A time-stamp representing the end of the range to query in milliseconds since epoch (required).

e.g. &start=1365487800000&end=1365491400000

Return Data
The following JSON structure is returned.

{
  throughputIn: <average inbound throughput over the period, in bps>,
  throughputOut: <average outbound throughput over the period, in bps>,
  rtt: <average rtt over the period, in ms>,
  health: <average tcp application health over the period, in %>,
  dataIn: <inbound data over the period, in bytes>,
  dataOut: <outbound data over the period, in bytes>,
  {sources|applications|hosts}:
  [
    {
      name: <name of source, application or host>,
      dataIn: <inbound data, in bytes>,
      dataOut: <outbound data, in bytes>
    }
  ]
}

See Also
API Authentication
How to generate date specific reports using API queries
Reporting (v2)
Reporting: Utilization (v1)
Reporting: Quality
Reporting: Capacity
Events: Active