Sign in

v1

latestOpenAPI 3.0.12026-07-178827.6 KB
CarbonAware

Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period.

This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.

get/emissions/average-carbon-intensity

Query parameters

locationstring required
Example:eastus

The location name where workflow is run

startTimestring date-time required
Example:2022-03-01T15:30:00Z

The time at which the workflow we are measuring carbon intensity for started

endTimestring date-time required
Example:2022-03-01T18:30:00Z

The time at which the workflow we are measuring carbon intensity for ended

Response

Returns a single object that contains the information about the request and the average marginal carbon intensity

locationstring nullable

the location name where workflow is run

startTimestring date-time nullable

the time at which the workflow we are measuring carbon intensity for started

endTimestring date-time nullable

the time at which the workflow we are measuring carbon intensity for ended

carbonIntensitynumber double

Value of the marginal carbon intensity in grams per kilowatt-hour.

Example response

{
  "location": "eastus",
  "startTime": "2022-03-01T15:30:00Z",
  "endTime": "2022-03-01T18:30:00Z",
  "carbonIntensity": 345.434
}