Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1423321.2 KB

Returns estimated carbon emission values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.

post/v1/estimated-carbon-emissions

Request body

GroupByDimension[]

The dimensions available for grouping estimated carbon emissions.

EmissionsTypesEmissionsType[]

The emission types to include in the results. If absent, returns <code>TOTAL_LBM_CARBON_EMISSIONS</code> and <code>TOTAL_MBM_CARBON_EMISSIONS</code> emissions types.

Granularity'YEARLY_CALENDAR' | 'YEARLY_FISCAL' | 'QUARTERLY_CALENDAR' | 'QUARTERLY_FISCAL' | 'MONTHLY'

Specifies the time period over which emissions data is aggregated.

MaxResultsinteger

The maximum number of results to return in a single call. Default is 40.

NextTokenstring

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Response

Success

NextTokenstring

The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

All 2 operations