v1

latestOpenAPI 3.1.02026-07-24398280.9 KB

Baseline forecasts

Get forecast summary for the organization or a specific business entity

Retrieves the historical and forecasted emissions and intensity data for the entire organization or optionally filtered for a specific business entity.

get/v1/baseline_forecasts/projections_summaries/business_entity_summary

Query parameters

business_entity_idstring uuid

The unique identifier for a business entity to filter the summary. If omitted, the summary for the entire organization is returned.

baseline_scenario_idstring uuid

Return the summary for a specific baseline scenario. If omitted, the default baseline scenario will be used.

Response

Forecast summary retrieved successfully

functionalUnitIDstring uuid nullable

The ID of the functional unit for the forecasts.

forecastStartYearinteger required

The starting year of the forecast data - any data points prior to this year are historical.

mainMetricDisplayUnitstring nullable

The unit used for displaying the main metric.