Resource URL: /platform/<<version=3>>/statistics/summary/heat

    Overview: Heat mode lists /ifs files and directories that are the "hottest"
              by various important measures relating to system performance.

     Methods: GET

********************************************************************************

Method GET: File heat map, i.e. rate of file operations, and the type of
            operation listed by path/lin(s).

       URL: GET /platform/<<version=3>>/statistics/summary/heat

Query arguments:
       sort=<string> { drive_id | type | xfers_in | bytes_in | xfer_size_in |
                     xfers_out | bytes_out | xfer_size_out | access_latency |
                     access_slow | iosched_latency | iosched_queue | busy |
                     used_bytes_percent | used_inodes } Sort data by the
                     specified comma-separated field(s). Prepend 'asc:' or
                     'desc:' to a field to change the sort direction.
convertlin=<boolean> Convert lin to hex. Defaults to true.
   timeout=<integer> Timeout remote commands after NUM seconds, where NUM is
                     the integer passed to the argument.
 pathdepth=<integer> Squash paths to this directory depth. Defaults to none,
                     ie. the paths are not limited (Subject to the system
                     limits.)
   numeric=<boolean> Whether to convert hostnames or usernames to their human
                     readable form. False by default.
     events=<string> Only report specified event types(s). A comma separated
                     list of events. Defaults to all supported events. See
                     [...]/platform/3/statistics/summary/filters/events for a
                     complete list.
   maxpath=<integer> Maximum bytes allocated for looking up a path. An ASCII
                     character is 1 byte (It may be more for other types of
                     encoding). The default is 1024 bytes. Zero (0) means
                     unlimited (Subject to the system limits.)
    classes=<string> Specify class(es) for which statistics should be reported.
                     Default is all supported classes. See
                     [...]/platform/3/statistics/summary/filters/classes for a
                     complete list.
    totalby=<string> Aggregate per specified fields(s). Defaults to none.
  degraded=<boolean> Continue to report if some nodes do not respond.
      nodes=<string> Specify node(s) for which statistics should be reported. A
                     comma separated set of numbers. Default is 'all'. Zero (0)
                     should be passed in as the sole argument to indicate only
                     the local node.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "heat": {
      "items": {
        "type": "object", 
        "properties": {
          "node": {
            "required": true, 
            "type": "integer", 
            "description": "The node where this event occurred."
          }, 
          "event_type": {
            "required": true, 
            "type": "integer", 
            "description": "The event type id"
          }, 
          "class_name": {
            "required": true, 
            "type": "string", 
            "description": "The class of operation"
          }, 
          "lin": {
            "required": true, 
            "type": [
              "string", 
              "integer"
            ], 
            "description": "Logical inode (LIN)"
          }, 
          "operation_rate": {
            "required": true, 
            "type": "number", 
            "description": "Approximate operations per second for this lin."
          }, 
          "event_name": {
            "required": true, 
            "type": "string", 
            "description": "The type of event"
          }, 
          "time": {
            "required": true, 
            "type": "integer", 
            "description": "Unix Epoch time in seconds of the request."
          }, 
          "path": {
            "required": true, 
            "type": "string", 
            "description": "Canonical LIN path if known"
          }
        }
      }, 
      "type": "array"
    }
  }
}
