Get Totals

Get aggregated totals for business travels: record count, total distance, and total CO2e

GET /v1/business-travels/totals

Get Totals

JavaScript

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/business-travels/totals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/v1/business-travels/totals"

headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.dcycle.io/v1/business-travels/totals \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>'

200

{
  "total_co2e": 123,
  "total_km": 123,
  "count": 123
}

Get Totals

Returns aggregated statistics for business travels in your organization: total CO2e emitted, total distance traveled, and record count. Supports the same filters as the list endpoint.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

Your organization UUID

Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

transport_type[] · array[string]

Filter by transport type

Available values: car, metro, train, trolleybus, bus, motorbike, aircraft, ferry

Example: transport_type[]=train&transport_type[]=aircraft

status[] · array[string]

Filter by status

Available values: active, pending, loading, completed, error

Example: status[]=active

start_date · date

Filter by minimum travel date (inclusive)

Format: YYYY-MM-DD

Example: 2024-01-01

end_date · date

Filter by maximum travel date (inclusive)

Format: YYYY-MM-DD

Example: 2024-12-31

name · string

Search by name (case-insensitive substring match)

Example: offsite

name[] · array[string]

Filter by exact name values (multi-select, OR logic)

Example: name[]=Team offsite&name[]=Client visit

file_id[] · array[uuid]

Filter by source file UUID. Pass 00000000-0000-0000-0000-000000000000 to filter for records with no associated file.

Example: file_id[]=3fa85f64-5717-4562-b3fc-2c963f66afa6

created_at_from · datetime

Filter records created on or after this timestamp (inclusive)

Format: YYYY-MM-DDTHH:MM:SSZ

created_at_to · datetime

Filter records created on or before this timestamp (inclusive)

Format: YYYY-MM-DDTHH:MM:SSZ

co2e_status · string

Filter by CO2e calculation status

Available values: calculated, not_calculated

Response

total_co2e · number

Total CO2e in kg across all matching business travels

total_km · number

Total distance in kilometers

count · integer

Number of business travel records matching the filters

Example

cURL

curl -X GET "https://api.dcycle.io/v1/business-travels/totals?start_date=2024-01-01&end_date=2024-12-31&status[]=active" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

import requests
import os

response = requests.get(
    "https://api.dcycle.io/v1/business-travels/totals",
    headers={
        "x-api-key": os.getenv("DCYCLE_API_KEY"),
        "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
    },
    params={
        "start_date": "2024-01-01",
        "end_date": "2024-12-31",
        "status[]": ["active"],
    },
)

totals = response.json()
print(f"{totals['count']} trips, {totals['total_km']:.0f} km, {totals['total_co2e']:.2f} kg CO2e")

const axios = require('axios');

axios.get('https://api.dcycle.io/v1/business-travels/totals', {
  headers: {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
  },
  params: {
    start_date: '2024-01-01',
    end_date: '2024-12-31',
    'status[]': ['active'],
  },
})
.then(({ data }) => {
  console.log(`${data.count} trips, ${data.total_km} km, ${data.total_co2e} kg CO2e`);
})
.catch(error => console.error(error));

Successful Response

{
  "total_co2e": 14523.87,
  "total_km": 82150.0,
  "count": 127
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

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

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: Organization not found

{"detail": "Organization with id=UUID('...') not found", "code": "ORGANIZATION_NOT_FOUND"}

Use Cases

Compare Emissions by Transport Type

transport_types = ["car", "train", "aircraft", "bus"]
for t_type in transport_types:
    response = requests.get(
        "https://api.dcycle.io/v1/business-travels/totals",
        headers=headers,
        params={
            "transport_type[]": [t_type],
            "start_date": "2024-01-01",
            "end_date": "2024-12-31",
            "status[]": ["active"],
        },
    )
    totals = response.json()
    print(f"{t_type}: {totals['total_co2e']:.1f} kg CO2e ({totals['count']} trips, {totals['total_km']:.0f} km)")

Related Endpoints

List Business Travels

Browse individual travel records

Calculation Steps

See the CO2e breakdown for a specific trip