Organization
Other Operations
get-env-impact
[BETA] Retrieve organization environmental impact reports
GET /env-impact/{period}[BETA] Returns environmental impact reports for an organization
Path parameters
| Name | In | Description |
|---|---|---|
period | path |
Responses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
metadata | array of Env Metadata Entry | Metadata |
products | array of Env Product | Products |
Example output
{
"metadata": [
{
"amount": 0,
"unit": "string",
"value": "string"
}
],
"products": [
{
"impacts": [
{
"amount": 0,
"details": [
null
],
"unit": "string",
"value": "string"
}
],
"metadata": [
{
"amount": 0,
"unit": "string",
"value": "string"
}
],
"value": "string"
}
]
}SDK reference for get-env-impact: golang | Python | Java
CLI: exo api get-env-impact
get-organization
Retrieve an organization
GET /organizationResponses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
address | string | Organization address |
balance | number | Organization balance |
city | string | Organization city |
country | string | Organization country |
currency | string | Organization currency |
id | string | Organization ID |
name | string | Organization name |
postcode | string | Organization postcode |
Example output
{
"address": "string",
"balance": 0,
"city": "string",
"country": "string",
"currency": "string",
"id": "string",
"name": "string",
"postcode": "string"
}SDK reference for get-organization: golang | Python | Java
CLI: exo api get-organization
get-usage-report
Retrieve organization usage reports
GET /usage-reportReturns aggregated usage reports for an organization
Query parameters
| Name | In | Required | Description |
|---|---|---|---|
period | query | no |
Responses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
usage | array of Usage |
Example output
{
"usage": [
{
"description": "string",
"from": "string",
"product": "string",
"quantity": "string",
"to": "string",
"unit": "string",
"variable": "string"
}
]
}Usage
Usage
| Property | Type | Required | Description |
|---|---|---|---|
description | string | no | Description |
from | string | no | Period Start Date |
product | string | no | Product |
quantity | string | no | Quantity |
to | string | no | Period End Date |
unit | string | no | Unit |
variable | string | no | Variable |
SDK reference for get-usage-report: golang | Python | Java
CLI: exo api get-usage-report
Last updated on