---
title: "Query project carbon emissions metrics for an entire organization"
method: GET
path: "/organizations/{organization_id}/metrics/carbon"
---

# Query project carbon emissions metrics for an entire organization

`GET /organizations/{organization_id}/metrics/carbon`

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

## Path parameters

- `organization_id` string, ulid, required

## Query parameters

- `from` DateTimeFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `between` string — Between (comma-separated list)
  - `gt` string — Greater than
  - `gte` string — Greater than or equal
  - `lt` string — Less than
  - `lte` string — Less than or equal
- `to` DateTimeFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `between` string — Between (comma-separated list)
  - `gt` string — Greater than
  - `gte` string — Greater than or equal
  - `lt` string — Less than
  - `lte` string — Less than or equal
- `interval` 'day' | 'month' | 'year'

## Response `200`

OK

- OrganizationCarbon
  - `organization_id` string — The ID of the organization.
  - `meta` MetricsMetadata
    - `from` unknown
    - `to` unknown
    - `interval` unknown
    - `units` unknown
  - `projects` OrganizationProjectCarbon[]
    - `project_id` string — The ID of the project.
    - `project_title` string — The title of the project.
    - `values` MetricsValue[]
      - `value` unknown
      - `start_time` unknown
    - `total` number — The calculated total of the metric for the given interval.
  - `total` number — The calculated total of the metric for the given interval.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)
