Get aggregated machine statistics

get

https://api.controlup.com/historical/v1/machines/aggregated

Returns aggregated machine metrics (avg/min/max/count) grouped by a single machine dimension such as folder, operating system, hypervisor platform, Azure region/VM size, or GPU architecture/model. Always returns machine count (COUNT(DISTINCT computer_id)) plus one column per combination. Visit the Machine Statistics Report documentation for column descriptions and more details.

Query Params

groupBy

string

enum

required

Single machine dimension to group rows by.

metrics

array of strings

required

One or more machine metrics to aggregate. Repeat the parameter for multiple values.

metrics*

aggregations

array of strings

Aggregation functions to apply to each metric. Repeat for multiple. Default: avg.

aggregations

Allowed:

presetType

string

enum

Defaults to Default

Metric compatibility scope. Restricts which metrics are valid. Default: Default (all metrics).

Allowed:

_sortBy

string

Response field to sort by (must equal a returned

_sortOrder

string

enum

Sort order. Default: desc.

Allowed:

_timeFrom

date-time

required

Start date and time of the search period in the format: YYYY-MM-DD'T'hh:mm:ss.sssZ

_timeTo

date-time

required

End date and time of the search period in the format: YYYY-MM-DD'T'hh:mm:ss.sssZ

operatingSystem

string

Filter machines whose operating system contains this value (pre-aggregation filter).

hypervisorPlatform

string

Filter machines whose hypervisor platform contains this value (pre-aggregation filter).

azRegion

string

Filter machines whose Azure region contains this value (pre-aggregation filter).

azVmSize

string

Filter machines whose Azure VM size contains this value (pre-aggregation filter).

vmName

string

Filter machines whose VM name contains this value (pre-aggregation filter).

_page

int32

≥ 1

The page number returned. The first page is 1.

_limit

int32

1 to 10000

Grouped rows per page. Default: 100, maximum: 10000.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved

400Bad Request - one of the inputs isn't correct

401User is not authorized to access the resource

403Authorization details are not provided

500Internal Server Error

501Internal Server Error

504Internal Server Error