Skip to content
TotalView API

Get Batch Summary

GET
/api/v1/batch/{batch_id}/summary
 
curl --request GET \
  --url https://api.totalview.energy/api/v1/batch/example/summary \
  --header 'Authorization: Bearer <token>'

Get aggregated portfolio summary for all completed projects in a batch.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
batch_id
required
Batch Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
BatchSummaryResponse

Aggregated portfolio summary for all completed projects in a batch.

This schema provides portfolio-level emissions, impacts, and generation metrics suitable for visualization and reporting.

object
batch_id
required
Batch Id

Unique batch identifier

string
customer_id
required
Customer Id

Customer who owns this batch

string format: uuid
total_projects
required
Total Projects

Total projects in batch

integer
completed_projects
required
Completed Projects

Number of completed projects in summary

integer
project_names
required
Project Names

List of project names included in aggregation

Array<string>
total_capacity_mw
required
Total Capacity Mw

Total nameplate capacity across all projects (MW)

number
generation_summary
required
Generation Summary

Aggregated generation by fuel type (GWh)

object
key
additional properties
object
key
additional properties
number
impacts_summary
required
Impacts Summary

Aggregated environmental impacts by analysis type

object
key
additional properties
object
key
additional properties
number
emissions_summary
required
Emissions Summary

Aggregated emissions by analysis type and category

object
key
additional properties
object
key
additional properties
object
key
additional properties
number
aggregated_at
required
Aggregated At

Timestamp when aggregation was performed

string format: date-time
Example 
{
  "generation_summary": {
    "Natural Gas": {
      "Difference": -300.1,
      "Historical": 500.2,
      "Projected": 200.1
    },
    "Solar": {
      "Difference": 1234.5,
      "Historical": 0,
      "Projected": 1234.5
    }
  },
  "impacts_summary": {
    "Cradle_to_Grave_Analysis": {
      "DALYs": 1234.5,
      "PDFs": 456.7,
      "USD": 78900.12
    },
    "Operational_Analysis": {
      "DALYs": 890.1,
      "PDFs": 234.5,
      "USD": 45600.78
    }
  },
  "emissions_summary": {
    "Cradle_to_Grave_Analysis": {
      "Air": {
        "CO2 (kg)": -123456.78,
        "NOx (kg)": -456.12
      },
      "Water": {
        "BOD (kg)": -12.34
      }
    }
  }
}

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