Skip to content
TotalView API

Get Lifetime Dashboard

GET
/api/v1/projects/{project_id}/impacts/dashboard
 
curl --request GET \
  --url 'https://api.totalview.energy/api/v1/projects/example/impacts/dashboard?include_comparison=false' \
  --header 'Authorization: Bearer <token>'

Get optimized lifetime impact summary for dashboard display.

Returns pre-aggregated metrics, equivalencies, and trend data optimized for fast rendering.

Available to all users with at least summary results access.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string

Query Parameters

Section titled “Query Parameters ”
include_comparison
Include Comparison
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
LifetimeDashboardResponse

Optimized response for lifetime impact dashboard.

Pre-aggregated metrics, equivalencies, and trend data optimized for fast rendering.

object
project_id
required
Project Id
string format: uuid
project_name
required
Project Name
string
age_years
required
Age Years
number
total_generation_gwh
required
Total Generation Gwh
number
lifetime_capacity_factor
required
Lifetime Capacity Factor
number
primary_methodology
required
Primary Methodology
string
primary_methodology_name
required
Primary Methodology Name
string
avoided_co2e_tonnes
required
Avoided Co2E Tonnes
number
avoided_dalys
required
Avoided Dalys
number
avoided_pdfs
required
Avoided Pdfs
number
economic_value_usd
required
Economic Value Usd
number
equivalencies
required
ImpactEquivalencies

Human-relatable equivalencies for communication.

Converts abstract metrics into tangible comparisons that resonate with non-technical audiences.

object
cars_off_road_years
required
Cars Off Road Years

Equivalent passenger vehicles not driven for one year

number
flights_avoided
required
Flights Avoided

Equivalent cross-country flights avoided

number
miles_not_driven
required
Miles Not Driven

Equivalent miles not driven by average passenger vehicle

number
homes_powered_years
required
Homes Powered Years

Equivalent homes powered for one year

number
gallons_gasoline_avoided
required
Gallons Gasoline Avoided

Equivalent gallons of gasoline not consumed

number
trees_planted_equivalent
required
Trees Planted Equivalent

Equivalent trees planted and grown for 10 years

number
acres_forest_preserved
required
Acres Forest Preserved

Equivalent acres of forest preserved from deforestation

number
healthcare_costs_avoided_usd
required
Healthcare Costs Avoided Usd

Estimated healthcare costs avoided from reduced pollution

number
custom
Custom

Custom equivalencies defined by the customer

object
key
additional properties
EquivalencyEntry

A single custom equivalency.

object
value
required
Value
number
unit
required
Unit
string
description
required
Description
string
source
required
Source

Citation for conversion factor

string
conversion_factor
required
Conversion Factor

Factor used to convert from base unit

number
monthly_trend
required
Monthly Trend
Array<object>
MonthlyTrendPoint

Single point in monthly trend data for sparklines.

object
month
required
Month

Month in YYYY-MM format

string
generation_mwh
required
Generation Mwh
number
avoided_co2e_kg
required
Avoided Co2E Kg
number
capacity_factor
required
Capacity Factor
number
data_quality_score
required
Data Quality Score
number
yoy_generation_change_pct
required
Any of:
number
yoy_avoided_emissions_change_pct
required
Any of:
number
data_coverage_start
required
Data Coverage Start
string format: date-time
data_coverage_end
required
Data Coverage End
string format: date-time
data_lag_days
required
Data Lag Days
integer
last_updated
required
Last Updated
string format: date-time
methodology_comparison
Any of:
object
key
additional properties
MethodologyComparisonEntry

Single methodology’s results for side-by-side comparison.

object
methodology_id
required
Methodology Id
string
methodology_name
required
Methodology Name
string
description
required
Description
string
total_avoided_co2e_tonnes
required
Total Avoided Co2E Tonnes
number
total_avoided_dalys
required
Total Avoided Dalys
number
total_economic_value_usd
required
Total Economic Value Usd
number
relative_to_primary
Any of:
number
allocation_approach
required
Allocation Approach
string
lcia_method
required
Lcia Method
string
time_horizon_years
required
Time Horizon Years
integer
Example generated
{
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "project_name": "example",
  "age_years": 1,
  "total_generation_gwh": 1,
  "lifetime_capacity_factor": 1,
  "primary_methodology": "example",
  "primary_methodology_name": "example",
  "avoided_co2e_tonnes": 1,
  "avoided_dalys": 1,
  "avoided_pdfs": 1,
  "economic_value_usd": 1,
  "equivalencies": {
    "cars_off_road_years": 1,
    "flights_avoided": 1,
    "miles_not_driven": 1,
    "homes_powered_years": 1,
    "gallons_gasoline_avoided": 1,
    "trees_planted_equivalent": 1,
    "acres_forest_preserved": 1,
    "healthcare_costs_avoided_usd": 1,
    "custom": {
      "additionalProperty": {
        "value": 1,
        "unit": "example",
        "description": "example",
        "source": "example",
        "conversion_factor": 1
      }
    }
  },
  "monthly_trend": [
    {
      "month": "example",
      "generation_mwh": 1,
      "avoided_co2e_kg": 1,
      "capacity_factor": 1,
      "data_quality_score": 1
    }
  ],
  "yoy_generation_change_pct": 1,
  "yoy_avoided_emissions_change_pct": 1,
  "data_coverage_start": "2026-04-15T12:00:00Z",
  "data_coverage_end": "2026-04-15T12:00:00Z",
  "data_lag_days": 1,
  "last_updated": "2026-04-15T12:00:00Z",
  "methodology_comparison": {
    "additionalProperty": {
      "methodology_id": "example",
      "methodology_name": "example",
      "description": "example",
      "total_avoided_co2e_tonnes": 1,
      "total_avoided_dalys": 1,
      "total_economic_value_usd": 1,
      "relative_to_primary": 1,
      "allocation_approach": "example",
      "lcia_method": "example",
      "time_horizon_years": 1
    }
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}