# ApiTimeSeriesAggregateStatistics Data Model

Statistics related to one time series aggregate data point. It is 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.

Properties
name | data type | description
--- | --- | ---
sampleTime | string | The timestamp of the sample 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.
sampleValue | number | The sample data point value representing an actual sample value picked from the underlying data that is being aggregated.
count | number | The number of individual data points aggregated in this data point.

min

number

This minimum value encountered while producing this aggregate data point. If this is a cross-time aggregate then this is the minimum value encountered during the aggregation period. If this is a cross-entity aggregate then this is the minimum value encountered across all entities. If this is a cross-time, cross-entity aggregate, then this is the minimum value for any entity across the aggregation period.

minTime | string | The timestamp of the minimum 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.

max

number

This maximum value encountered while producing this aggregate data point. If this is a cross-time aggregate then this is the maximum value encountered during the aggregation period. If this is a cross-entity aggregate then this is the maximum value encountered across all entities. If this is a cross-time, cross-entity aggregate, then this is the maximum value for any entity across the aggregation period.

maxTime | string | The timestamp of the maximum 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.
mean | number | The mean of the values of all data-points for this aggregate data point.
stdDev | number | The standard deviation of the values of all data-points for this aggregate data point.
crossEntityMetadata | ApiTimeSeriesCrossEntityMetadata | If the data-point is for a cross entity aggregate (e.g., fd_open_across_datanodes) returns the cross entity metadata, null otherwise.

Example

    {
      "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
      }
    }