Add-ons1

Alerts2

API Tokens4

Autoscaling3

Cert Management8

Connections3

Deployment2

Deployment Target5

Discounts3

Domain Management10

Environment19

Environment Activity3

Environment Backups5

Environment Type2

Environment Variables5

Grants1

Invoices2

MFA8

Orders4

Organization Invitations3

Organization Management5

Organization Members5

Organization Projects6

Organizations6

PhoneNumber2

Profiles4

Project5

Project Activity3

Project Invitations3

Project Settings2

Project Variables5

Records2

References5

Regions2

Repository5

Routing2

Runtime Operations1

Source Operations2

SSH Keys3

Subscriptions13

Support4

System Information2

Team Access8

Teams10

Third-Party Integrations5

User Access10

User Profiles7

Users10

Vouchers2

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

Request

Base URL
https://api.upsun.com
Auth
OAuth 2
Authorization codehttps://auth.api.platform.sh/oauth2/authorize
Token URLhttps://auth.api.platform.sh/oauth2/token
TypeScript
https://skmtc.dev/upsun/apis/upsun-com-rest-api/docs/organizations/:organization_id/metrics/carbon/get.ts
A function with typed inputs. Its response is checked against the schema.

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

organization_idstring

The ID of the organization.

totalnumber

The calculated total of the metric for the given interval.

Changes

No recorded changes to this operation across all 1 revision of this API.