---
title: "Retrieve organization usage reports"
method: POST
path: "/organization/usage"
---

# Retrieve organization usage reports

`POST /organization/usage`

## Request

- Base URL: `https://app.chloris.earth/api`
- URL: `https://app.chloris.earth/api/organization/usage`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/chloris/apis/chloris-platform-api/docs/organization/usage/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `periodId` string: period ID, typically the year followed by either the ISO 8601 week number or month number
  - `organizationId` string: organization ID
  - `nextToken` string: Token used for pagination. Omitted if there are no more results.

## Response `200`

Success

- object
  - `nextToken` string: Token used for pagination. Omitted if there are no more results.
  - `usageReports` OrganizationUsageReport[]
    - `organizationId` string: organization ID
    - `periodId` string: period ID
    - `activeCount` integer: Total number of active sites at the time of the report
    - `createdCount` integer: New sites created during the period
    - `analyzedCount` integer: New sites analyzed during the period
    - `deliveredCount` integer: New sites delivered during the period
    - `activeAreaKm2` number: Total area km2 of active sites at the time of the report.
    - `createdAreaKm2` number: New area km2 created during the period.
    - `analyzedAreaKm2` number: New area km2 analyzed during the period.
    - `deliveredAreaKm2` number: New area km2 delivered (both analyzed and reviewed) during the period.
    - `active30mAreaKm2` number: Total 30m area km2 of active sites at the time of the report.
    - `created30mAreaKm2` number: New 30m area km2 created during the period.
    - `analyzed30mAreaKm2` number: New 30m area km2 analyzed during the period.
    - `delivered30mAreaKm2` number: New 30m area km2 delivered (both analyzed and reviewed) during the period.
    - `active10mAreaKm2` number: Total 10m area km2 of active sites at the time of the report.
    - `created10mAreaKm2` number: New 10m area km2 created during the period.
    - `analyzed10mAreaKm2` number: New 10m area km2 analyzed during the period.
    - `delivered10mAreaKm2` number: New 10m area km2 delivered (both analyzed and reviewed) during the period.

## Other responses

- `403`: Forbidden

---

[API](https://skmtc.dev/chloris/apis/chloris-platform-api.md) - [All operations](https://skmtc.dev/chloris/apis/chloris-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/chloris/apis/chloris-platform-api/revisions/e675ad2bd035?raw)