v1

latestOpenAPI 3.1.02026-07-24398280.9 KB

Baseline forecasts

Get main metric projections

Retrieves a list of main metric projections filtered by baseline scenario ID and optionally by business entity ID. If no business entity ID is provided, the main metric projections for the entire organization will be returned. This endpoint supports pagination, since the number of main metric projections can be quite large.

get/v1/baseline_forecasts/main_metric_projections

Query parameters

baseline_scenario_idstring uuid required

The ID of the baseline scenario to filter the main metric projections by

business_entity_idstring uuid

The ID of the business entity to filter the main metric projections by

offsetinteger

The offset of the main metric projections to retrieve

limitinteger

The limit of the main metric projections to retrieve

Response

Main metric projections retrieved successfully

Example response

{
  "projections": [
    {
      "config": {
        "startYear": "2025",
        "endYear": "2025",
        "projectionMethod": {
          "projectionMethod": "HISTORICAL_AVERAGE_GROWTH_RATE",
          "baseYear": "2025",
          "historicalPeriodStart": "2025",
          "historicalPeriodEnd": "2025"
        }
      },
      "projection": {
        "startYear": "2025",
        "endYear": "2025",
        "valuesBaseYear": "2025",
        "functionalUnit": {
          "defaultDisplayUnit": "kg",
          "supportedUnits": [
            "kg"
          ]
        },
        "displayUnit": "kg",
        "historicalValues": [
          {
            "year": "2025"
          }
        ],
        "projectedValues": [
          {
            "year": "2025"
          }
        ]
      }
    }
  ]
}