Get Totals
Get Totals
Get aggregated CO2e emissions and quantity totals for transport routes
GET
Get Totals
Get Totals
Return aggregated totals for transport routes — total CO2e emissions, total quantity transported (in kg), record count, and percentage change compared to the same period in the previous year. Supports the same filters as the list endpoint.Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faQuery Parameters
string
Free-text search (min 1, max 255 characters)
string
Filter routes with dates on or after this date (ISO 8601)Example:
2025-01-01string
Filter routes with dates on or before this date (ISO 8601)Example:
2025-12-31string[]
Filter by calculation status:
pending, active, errorstring
Filter by direction:
downstream or upstreamstring[]
Filter by bulk-upload file UUIDs
string
Filter routes created on or after this datetime (ISO 8601)
string
Filter routes created on or before this datetime (ISO 8601)
string
Filter by CO2e calculation status
string[]
Filter by supplier name (exact match). Pass multiple values to include routes from several suppliers.
Response
number
Sum of CO2e emissions across all matching routes (tCO2e). Default:
0.0number
Sum of transported quantity across all matching routes (kg). Default:
0.0integer
Number of matching transport routes. Default:
0number | null
Percentage change in CO2e vs the same period in the previous year.
null if no prior-year data exists.number | null
Percentage change in quantity (kg) vs the same period in the previous year.
null if no prior-year data exists.Example
Successful Response
Common Errors
401 Unauthorized
Cause: Missing or invalid API key403 Forbidden
Cause: The authenticated user is not a member of the organizationRelated Endpoints
List Transport Routes
Retrieve all transport routes with filtering and pagination
Get Route Counts
Count routes grouped by calculation status