latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Query project carbon emissions metrics for an entire organization

Queries the carbon emission data for all projects owned by the specified organiation.

get/organizations/{organization_id}/metrics/carbon

Path parameters

organization_idstring ulid required

The ID of the organization.

Query parameters

eqstring

Equal

nestring

Not equal

betweenstring

Between (comma-separated list)

gtstring

Greater than

gtestring

Greater than or equal

ltstring

Less than

ltestring

Less than or equal

The start of the time frame for the query. Inclusive.

eqstring

Equal

nestring

Not equal

betweenstring

Between (comma-separated list)

gtstring

Greater than

gtestring

Greater than or equal

ltstring

Less than

ltestring

Less than or equal

The end of the time frame for the query. Exclusive.

interval'day' | 'month' | 'year'

The interval by which the query groups the results. of the time frame for the query. Exclusive.

Response

OK

organization_idstring

The ID of the organization.

totalnumber

The calculated total of the metric for the given interval.