Baseline forecasts

Get a main metric projection by its ID

Retrieves a main metric projection and its config by its ID.

get/v1/baseline_forecasts/main_metric_projections/{id}

Request

Base URL
https://api.sinai.com
Auth
- OAuth 2
  Client credentials
  Token URLhttps://auth.sinai.com/oauth2/token
  Scopeshttps://api.sinai.com/baseline_forecasts
- or OAuth 2
  Authorization codehttps://auth.sinai.com/oauth2/authorize
  Token URLhttps://auth.sinai.com/oauth2/token
TypeScript
https://skmtc.dev/sinai/apis/sinai-api/docs/v1/baseline_forecasts/main_metric_projections/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the main metric projection to retrieve

Response

Main metric projection retrieved successfully

Example response

{
  "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"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.