Skip to main content
GET
/
vehicle
/
summary
Get all vehicle summaries
curl --request GET \
  --url https://ctechnology.io/api/v2.2/vehicle/summary \
  --header 'Authorization: <api-key>'
{
  "header": {
    "num_results": 123,
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "via": "me",
        "organization_id": "<string>"
      }
    ],
    "offset": 123,
    "limit": 123
  },
  "data": [
    {
      "timestamp": "2023-12-25",
      "speed_max": 123,
      "speed_avg": 123,
      "distance_tot": 123,
      "duration_tot": 123,
      "battery_main_min": 123,
      "battery_main_max": 123,
      "num_trips": 123,
      "fuel_used": 123,
      "fuel_num_refueled": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Note that the API key has to be sent as Token 123 where 123 is the key you received after logging in or by creating on the developer dashboard.

Query Parameters

​
interval
enum<string>
required

The summarization interval used. The summarization interval used to summarize vehicle data.

Available options:
day,
week,
quarter,
month,
year
​
from
string<date-time>
required

The starting date/time.

​
to
string<date-time>
required

The ending date/time.

​
role
enum<string>

The role in which to act to get the summaries. This restricts the number of vehicles that are considered.

The access role of a user (when making a request that can be used in different contexts),

Available options:
owner,
professional,
oem

Response

Successful retrieval of the vehicle summaries.

​
header
API Header Paginated · object
required

Default header sent along with multi-resource responses (lists of resources).

​
data
Vehicle Summary · object[]
required