ApiTimeSeriesData Data Model

A single data point of time series data.

Properties
name data type description
timestamp string The timestamp for this time series data point. Note that the timestamp reflects coordinated universal time (UTC) and not necessarily the server's time zone. The rest API formats the UTC timestamp as an ISO-8061 string.
value number The value of the time series data.
type string The type of the time series data.
aggregateStatistics ApiTimeSeriesAggregateStatistics Available from v6 for data points containing aggregate data. It includes further statistics about the data point. An aggregate can be across entities (e.g., fd_open_across_datanodes), over time (e.g., a daily point for the fd_open metric for a specific DataNode), or both (e.g., a daily point for the fd_open_across_datanodes metric). If the data point is for non-aggregate date this will return null.

Example

{
  "timestamp" : "...",
  "value" : 12345.0,
  "type" : "...",
  "aggregateStatistics" : {
    "sampleTime" : "...",
    "sampleValue" : 12345.0,
    "count" : 12345,
    "min" : 12345.0,
    "minTime" : "...",
    "max" : 12345.0,
    "maxTime" : "...",
    "mean" : 12345.0,
    "stdDev" : 12345.0,
    "crossEntityMetadata" : {
      "maxEntityDisplayName" : "...",
      "maxEntityName" : "...",
      "minEntityDisplayName" : "...",
      "minEntityName" : "...",
      "numEntities" : 12345.0
    }
  }
}