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

NameInDescription
periodpath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
metadataarray[object]Metadata schema details
productsarray[object]Products schema details
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 /organization

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
addressstringOrganization address
balancenumberOrganization balance
citystringOrganization city
countrystringOrganization country
currencystringOrganization currency
idstringOrganization ID
namestringOrganization name
postcodestringOrganization 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-report

Returns aggregated usage reports for an organization

Query parameters

NameInRequiredDescription
periodqueryno

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
usagearray[object]schema details
Example output
{
  "usage": [
    {
      "description": "string",
      "from": "string",
      "product": "string",
      "quantity": "string",
      "to": "string",
      "unit": "string",
      "variable": "string"
    }
  ]
}

SDK reference for get-usage-report: golang | Python | Java

CLI: exo api get-usage-report

Last updated on