Baseline forecasts
Get an activity projection by its ID
Retrieves an activity projection and its config by its ID.
get/v1/baseline_forecasts/activity_projections/{id}
Request
- Base URLhttps://api.sinai.com
- Auth
- OAuth 2Client credentialsToken URLhttps://auth.sinai.com/oauth2/tokenScopeshttps://api.sinai.com/baseline_forecasts
- or OAuth 2Authorization codehttps://auth.sinai.com/oauth2/authorizeToken URLhttps://auth.sinai.com/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
The ID of the activity projection to retrieve
Response
Activity projection retrieved successfully
Example response
{
"config": {
"startYear": "2025",
"endYear": "2025",
"valueProjectionMethod": {
"projectionMethod": "HISTORICAL_AVERAGE_GROWTH_RATE",
"baseYear": "2025",
"historicalPeriodStart": "2025",
"historicalPeriodEnd": "2025"
},
"emissionsProjectionMethod": {
"projectionMethod": "HISTORICAL_AVERAGE_GROWTH_RATE",
"baseYear": "2025",
"historicalPeriodStart": "2025",
"historicalPeriodEnd": "2025"
},
"emissionsFactorsOverrides": [
{
"unit": "kg"
}
],
"secondaryActivityValueOverrides": [
{
"unit": "kg"
}
]
},
"projection": {
"startYear": "2025",
"endYear": "2025",
"serverUnit": "kg",
"displayUnit": "kg",
"emissionsUnit": "kg",
"secondaryActivityValues": [
{
"year": "2025"
}
],
"historicalActivityValues": [
{
"year": "2025"
}
],
"projectedActivityValues": [
{
"year": "2025"
}
],
"historicalScopeEmissions": [
{
"year": "2025"
}
],
"projectedScopeEmissions": [
{
"year": "2025"
}
],
"historicalBioCO2Emissions": [
{
"year": "2025"
}
],
"projectedBioCO2Emissions": [
{
"year": "2025"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.