Skip to main content
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_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

Free-text search (min 1, max 255 characters)
string
Filter routes with dates on or after this date (ISO 8601)Example: 2025-01-01
string
Filter routes with dates on or before this date (ISO 8601)Example: 2025-12-31
string[]
Filter by calculation status: pending, active, error
string
Filter by direction: downstream or upstream
string[]
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.0
number
Sum of transported quantity across all matching routes (kg). Default: 0.0
integer
Number of matching transport routes. Default: 0
number | 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 key

403 Forbidden

Cause: The authenticated user is not a member of the organization

List Transport Routes

Retrieve all transport routes with filtering and pagination

Get Route Counts

Count routes grouped by calculation status