Timeseries of cloud carbon footprint usage over time

get/sustainability-insight-ctr/v1beta1/cloud-usage-series

Retrieves aggregated carbon footprint 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.

OData 4.0 Documentation
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')
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). Cloud usage typically is measured in months, so the smaller time units are likely to be approximations.

Examples:
interval=1 month
interval=3 months
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
}