reporting.get_data ================== Get reporting data for given graphs. List of possible graphs can be retrieved using `reporting.graphs` call. For the time period of the graph either `unit` and `page` OR `start` and `end` should be used, not both. `aggregate` will return aggregate available data for each graph (e.g. min, max, mean). .. examples(websocket):: Get graph data of "nfsstat" from the last hour. :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "reporting.get_data", "params": [ [{"name": "nfsstat"}], {"unit": "HOURLY"}, ] } .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: graphs

graphs

Type: array of object

Array of graph identifiers specifying which metrics to retrieve.

Must contain a minimum of 1 items

No Additional Items
Each item of this array must be:

GraphIdentifier

Type: object
No Additional Properties

Name

Type: enum (of string)

Type of performance metric to retrieve.

  • cpu: CPU usage statistics
  • cputemp: CPU temperature readings
  • disk: Disk I/O statistics
  • interface: Network interface statistics
  • load: System load averages
  • processes: Process count and statistics
  • memory: Memory usage statistics
  • uptime: System uptime
  • arcactualrate: ZFS ARC actual hit rate
  • arcrate: ZFS ARC hit rate
  • arcsize: ZFS ARC cache size
  • arcresult: ZFS ARC operation results
  • disktemp: Disk temperature readings
  • upscharge: UPS battery charge level
  • upsruntime: UPS estimated runtime
  • upsvoltage: UPS voltage readings
  • upscurrent: UPS current readings
  • upsfrequency: UPS frequency readings
  • upsload: UPS load percentage
  • upstemperature: UPS temperature readings
Must be one of:
  • "cpu"
  • "cputemp"
  • "disk"
  • "interface"
  • "load"
  • "processes"
  • "memory"
  • "uptime"
  • "arcactualrate"
  • "arcrate"
  • "arcsize"
  • "arcresult"
  • "disktemp"
  • "upscharge"
  • "upsruntime"
  • "upsvoltage"
  • "upscurrent"
  • "upsfrequency"
  • "upsload"
  • "upstemperature"

Identifier

Default: null

Specific instance identifier for the metric (e.g., device name, interface name). null for system-wide metrics.

Type: string

Must be at least 1 characters long

Type: null
Parameter 2: query

query

Type: object

Query parameters for filtering and formatting the returned data.

 No Additional Properties

Unit

Default: null

Time unit for data aggregation. null for default aggregation.

Type: enum (of string)
Must be one of:
  • "HOUR"
  • "DAY"
  • "WEEK"
  • "MONTH"
  • "YEAR"
Type: null

Page

Type: integer Default: 1

Page number for paginated results.

Value must be greater or equal to 1

Aggregate

Type: boolean Default: true

Whether to return aggregated data or raw data points.

Start

Default: null

Start timestamp for the data range. null for default start time.

Type: integer

Value must be strictly greater than 0

Type: null

End

Default: null

End timestamp for the data range. null for current time.

Type: integer

Value must be strictly greater than 0

Type: null

Result

Type: array of object

Array of performance data responses for each requested graph.

 No Additional Items
Each item of this array must be:

ReportingGetDataResponse

Type: object
No Additional Properties

Name

Type: string

Name of the performance metric.

Must be at least 1 characters long

Identifier


Specific instance identifier for the metric. null for system-wide metrics.

Type: string
Type: null

Data

Type: array

Array of time-series data points for the requested time period.

 No Additional Items
Each item of this array must be:
Type: object

Aggregations

Type: object

Statistical aggregations of the data over the time period.

 No Additional Properties

Min

Type: object

Minimum values for each data series over the time period.

Mean

Type: object

Average values for each data series over the time period.

Max

Type: object

Maximum values for each data series over the time period.

Start

Type: integer

Actual start timestamp of the returned data.

Value must be strictly greater than 0

End

Type: integer

Actual end timestamp of the returned data.

Value must be strictly greater than 0

Legend

Type: array of string

Array of labels describing each data series in the results.

 No Additional Items
Each item of this array must be:
Type: string


*Required roles:* REPORTING_READ