Reporting: Utilization (v1)

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

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

GET /api/v1/reports/utilization.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+AND+application+%3d+HTTP

group: The utilization report to retrieve. Must be one of application, host-internal, host-external, or source (required).

e.g. &group=application

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.

{
  dataIn: <total inbound data for the period, in bytes>,
  dataOut: <total outbound data for the period, in bytes>,
  pktsIn: <total inbound packets for the period>,
  pktsOut: <total outbound packets for the period>,
  throughputIn: <average inbound throughput over the period, in bps>,
  throughputOut: <average outbound throughput over the period, in bps>,
  summary: [
    {
      name: <application name, host name/ip, or source name>,
      dataIn: <inbound data for the period, in bytes>,
      dataOut: <outbound data for the period, in bytes>,
      pktsIn: <inbound packets for the period>,
      pktsOut: <outbound packets for the period>,
      throughputIn: <inbound throughput over the period, in bps>,
      throughputOut: <outbound throughput over the period, in bps>
    }
  ],
  timeseries: {
    throughputIn: {
      series [
        <name of series>
      ],
      data [
        {
          timestamp: <timestamp of sample>,
          0: <value of 1st series>,
          1: <value of 2nd series>,
          2: <value of 3rd series>,
          3: <value of 4th series>,
          4: <value of 5th series>,
          5: <value of 6th series>
        }
      ]
    },
    throughputOut: {
      series [
        <name of series>
      ],
      data [
        {
          timestamp: <timestamp of sample>,
          0: <value of 1st series>,
          1: <value of 2nd series>,
          2: <value of 3rd series>,
          3: <value of 4th series>,
          4: <value of 5th series>,
          5: <value of 6th series>
        }
      ]
    }
  }
}

Example
This example fetches all the application data for the 15th April 2013. Request

curl -u <username>:<password> -H 'Content-Type: application/json' \
    'https://app.sinefa.com/api/v1/reports/utilization.json?filter=&group=application&start=1365948000000&end=1366034399000'

Response

{
  "dataIn": 12043575793,
  "dataOut": 12125244027,
  "pktsIn": 27600001,
  "pktsOut": 27578925,
  "throughputIn": 233931.271113323,
  "throughputOut": 235529.147943277,
  "summary": [
    {
      "name": "HTTP",
      "pktsOut": 10121289,
      "pktsIn": 10121127,
      "throughputOut": 30933.5797043497,
      "throughputIn": 30933.5099369078,
      "dataOut": 8371281687,
      "dataIn": 8371271967
    },
    ...
  ],
  "timeseries": {
    "throughputIn": {
      "data": [
        {
          "4": 8478.05,
          "1": 913.85,
          "timestamp": "2013-04-14T14:00:00.000Z",
          "3": 8428.13333333333,
          "0": 249607.533333333,
          "2": 9995.71666666667,
          "5": 45064.65
        },
        ...
      ],
      "series": [
        "HTTP",
        "Sinefa",
        "HTTPS",
        "SMB",
        "Citrix ICA",
        "Other"
      ]
    },
    "throughputOut": {
      "data": [
        {
          "4": 8478.05,
          "1": 904.45,
          "timestamp": "2013-04-14T14:00:00.000Z",
          "3": 8428.13333333333,
          "0": 249607.533333333,
          "2": 11155.0666666667,
          "5": 45064.65
        },
        ...
      ],
      "series": [
        "HTTP",
        "Sinefa",
        "HTTPS",
        "SMB",
        "Citrix ICA",
        "Other"
      ]
    }
  }
}

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