ApiTimeSeriesCrossEntityMetadata Data Model

A class holding additional metadata to the ApiTimeSeriesAggregateStatistics class that applies specifically to cross-entity aggregate metrics.

Properties
name data type constraints description
maxEntityDisplayName string   The display name of the entity that had the maximum value for the cross-entity aggregate metric.
maxEntityName string   The name of the entity that had the maximum value for the cross-entity aggregate metric.

Available since API v11.

minEntityDisplayName string   The display name of the entity that had the minimum value for the cross-entity aggregate metric.
minEntityName string   The name of the entity that had the minimum value for the cross-entity aggregate metric.

Available since API v11.

numEntities number required The number of entities covered by this point. For a raw cross-entity point this number is exact. For a rollup point this number is an average, since the number of entities being aggregated can change over the aggregation period.

Example

{
  "maxEntityDisplayName" : "...",
  "maxEntityName" : "...",
  "minEntityDisplayName" : "...",
  "minEntityName" : "...",
  "numEntities" : 12345.0
}