API Reference

Get machine statistics

get
https://api.controlup.com/historical/v1/machines/statistics/

Returns historical information about machine resource consumption. Visit the Machine Statistics Report documentation for column descriptions and more details.

Required permission: Machine Statistics

❗️

The built-in Try It! console can return incorrect values. This endpoint returns IDs that are automatically rounded and displayed incorrectly in the response body due to a Javascript limitation.

  • Use the console to build requests and test connectivity only.
  • To get accurate data, copy the request and run it in another tool.
Path Params
string
enum
required

Returns machine resource consumption statistics grouped by the specified entity

Allowed:
Query Params
string
enum
required

Set how machine statistics are aggregated during the selected time range. Avg returns the average of each metric. Max returns the maximum of each metric. Min returns the minimum of each metric. Worst returns either the maximum or minimum of each metric according to each metric type.

Allowed:
string
enum
required

The type of information to return. Default returns all available information.

Allowed:
date-time
required

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

date-time
required

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

int32
≥ 1

The page number returned. The first page is 1.

int32
1 to 100000

The number of items returned per page. Minimum is 1.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?