Retrieve aggregated metric data for multiple counters

POST 
/query/metric/aggregations

This endpoint retrieves aggregated historical data for multiple specified metrics over a given timeline. The data is aggregated using methods such as avg (average), sum, min, max, or count, based on the user's request. Users can specify multiple data points (e.g., system.cpu.percent, system.memory.used.percent) along with the entity type (e.g., monitor) and a list of specific entities. Additionally, the timeline for the data can be customized, allowing users to fetch both current and historical data. Unlike the histogram API, this endpoint returns aggregated values rather than time series data, providing a summary view of the metrics based on the selected parameters.

Request

application/json

Body

required

queries object[]required
A list of queries to retrieve data for multiple metrics. Each query can specify the aggregator, data point, and entity type. To query multiple metrics, add additional query objects, each containing these parameters.
Array [
aggregator stringrequired
The method of aggregation for the data points, such as 'avg', 'sum', 'min', 'max', and 'count'
data.point stringrequired
The specific metric or data point to query, for example, 'system.cpu.percent'.
entity.type string
The type of entity for which data is being retrieved, for example, 'monitor'.
entities integer[]
The specific entity IDs to query the data for. The ID could be a Monitor ID, Group ID, or a Tag value based on the 'entity.type' you have selected
]
timeline objectrequired

Defines the time range for the data being retrieved. This includes the start and end dates and times.

from.date daterequired

The start date for the data retrieval.

from.time timerequired

The start time for the data retrieval.

to.date daterequired

The end date for the data retrieval.

to.time timerequired

The end time for the data retrieval.

type stringrequired

Specifies the type of data to be retrieved, such as 'metric'. The possible type of data that can be retrieved are 'metric' and 'availability'.

result.by string[]required

An array of strings specifying how the results should be grouped, The possible values are 'monitor', 'tag', 'group', and 'instance'.

Responses

200

Successfully retrieved Historical data with respect to data point with specific aggregator and specific entity type.

application/json

Schema

Schema

oneOf
Performance_Scalar_Metric_Aggregation_Category
response-code integer
status string
result object[]
Array [
monitor stringrequired
system.cpu.percent^avg integer
system.running.processes^avg integer
system.disk.read.bytes^avg integer
]
Performance_Instance_Metric_Aggregation_Category
response-code integer
status string
result object[]
Array [
monitor stringrequired
esxi.network.interface~bytes.per.sec^avg integer
esxi.network.interface~out.bytes.per.sec^avg integer
esxi.network.interface~in.bytes.per.sec^avg integer
]

Example (from schema)

{}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

The client is not authorized to access this resource. Ensure that the correct permissions are granted.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

An unexpected error occurred on the server. This might be due to a temporary issue or a problem with the request processing.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...