Aggregated carbon footprint usage for cloud entities

get/sustainability-insight-ctr/v1beta1/cloud-usage-by-entity

Retrieves aggregated carbon footprint usage in a list grouped by individual cloud entities, i.e., cloud services, over a defined time frame and supports filtering, sorting, and offset-based pagination.

Securitybearer
Request
query Parameters
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 cloud 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.

Cloud entities can be filtered by:

  • entityId
  • serviceProvider
  • serviceName
  • serviceRegion
  • serviceAccount
  • name
Examples:
filter=serviceProvider eq 'AWS'
filter=serviceRegion in ('EMEA', 'AMERICAS')
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 "entityId", "serviceProvider", "serviceName", "serviceRegion", "serviceAccount", "name". Must be of the format "property order".

Examples:
sort=serviceAccount asc
sort=entityId desc
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": 5,
  • "total": 10,
  • "offset": 5
}