Retrieves aggregated energy usage statistics grouped by time bucket over a defined time frame and supports filtering by entities. Behavior is non-deterministic if the time range does not divide evenly by your selected interval.
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 usage for 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
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 ''
interval
required
string
Interval of the created time series. Must be of the format "integer unit". Valid units are day(s), hour(s), week(s), month(s), and year(s).
Examples:
interval=1 day
interval=2 hours
start-time
required
string
Start of the query's time range in ISO8601 format.