Retrieves an aggregated energy usage list grouped by individual entities over a defined time frame and supports filtering, sorting, and offset-based pagination.
The 3 letter currency code the cost returned will be in, case insensitive. Currency calculations are done via a factor queried at the beginning of the day. Defaults to USD.
Enum:"AED""AUD"… 28 more Examples:
currency=CAD
end-time
required
string
End of the query's time range in ISO8601 format.
Examples:
end-time=2024-01-29T08:00:00Z
filter
string
Limit the entities operated on by this endpoint, returning only the subset of entities that match the filter. The filter grammar is a subset of OData 4.0 supporting "eq", "in", and "and" operators only.
Usage entities can be filtered by:
entityId
entityMake
entityModel
entityType
entitySerialNum
entityProductId
locationName
locationId
locationCity
locationState
locationCountry
name
Examples:
filter=locationCountry eq 'DE'
filter=entityModel in ('ProLiant DL325 Gen11', 'ProLiant DL380 Gen10')
filter-tags
string
Limit the entities operated on by this endpoint, returning only the subset of entities that contain the tags. The filter grammar is a subset of OData 4.0 supporting "eq" and "or" operators only.
The tag key is on the left of the operator, the value is on the right.
Examples:
filter-tags='OS' eq 'Linux'
filter-tags='OS' eq 'Linux' or 'OS' eq 'Windows'
filter-tags='Tagged' eq ''
limit
integer <int32> [ 0 .. 100 ]
Default: 10
Number of usages to return.
Examples:
limit=10
offset
integer <int32> >= 0
Default: 0
Zero-based resource offset to start the response from.
Examples:
offset=10
sort
string
Odata 4.0 field to sort entities on. Allowed fields are the strings "locationName", "locationCountry", "locationState", "entityId", "entityMake", "entityModel", "entityType", "entitySerialNum", "entityProductId", "name". Must be of the format "property order".
Examples:
sort=name asc
sort=entityId desc
start-time
required
string
Start of the query's time range in ISO8601 format.