Total aggregated data

get/sustainability-insight-ctr/v1beta1/usage-totals

Returns the total aggregated power cost, power consumption, and carbon emissions over a defined time frame and supports filtering by entities.

Securitybearer
Request
query Parameters
currency
string (currencyCode)
Default: "USD"

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 aggregate'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 ''
start-time
required
string

Start of the query's time range in ISO8601 format.

Examples:
start-time=2024-01-28T08:00:00Z
Responses
200

OK

400

Bad Request. Incorrect Input.

401

Unauthorized

429

Exceeded the allowed rate limit.

500

Unexpected Server Error

Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "count": 10
}