Skip to main content

​
Available Tools

ToolEndpointDescription
get_emissionsGET /api/v1/emissionsList of calculated emissions
get_emissions_dashboardGET /api/v1/emissions/dashboardDashboard by scope, category and building

​
Usage Examples

"What are my total emissions in 2024?"
→ get_emissions_dashboard({ companyId: "uuid", startDate: "2024-01-01", endDate: "2024-12-31" })

"Show me Scope 1 emissions for the last quarter"
→ get_emissions({ companyId: "uuid", scopeIds: ["scope-1-uuid"], startDate: "2024-10-01", endDate: "2024-12-31" })

"Which building generates the most emissions?"
→ get_emissions_dashboard({ companyId: "uuid", groupBy: "building" })

​
Common Parameters

​
get_emissions_dashboard

ParameterTypeDescription
companyIdstringCompany ID (required)
startDatestringStart date (ISO 8601)
endDatestringEnd date (ISO 8601)
categoryIdsstring[]Filter by GHG categories
buildingIdsstring[]Filter by buildings
entityIdsstring[]Filter by entities
hasCountriesbooleanBreak down by country

​
get_emissions

ParameterTypeDescription
companyIdstringCompany ID (required)
startDatestringStart date
endDatestringEnd date
categoryIdsstring[]Filter by categories
buildingIdsstring[]Filter by buildings
pageintegerPage number
limitintegerResults per page

​
Dashboard Response

The dashboard includes aggregated data by:
  • Scope — Scope 1, Scope 2, Scope 3
  • Category — Electricity, fuels, transport, etc.
  • Building — Emissions per location
  • Month — Time series evolution