Get all vehicle summaries

Returns the summaries of all vehicles with the given requirements.

GET /vehicle/summary

Get all vehicle summaries

cURL

curl --request GET \
  --url https://ctechnology.io/api/v2.2/vehicle/summary \
  --header 'Authorization: <api-key>'

import requests

url = "https://ctechnology.io/api/v2.2/vehicle/summary"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

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

fetch('https://ctechnology.io/api/v2.2/vehicle/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ctechnology.io/api/v2.2/vehicle/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ctechnology.io/api/v2.2/vehicle/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ctechnology.io/api/v2.2/vehicle/summary")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ctechnology.io/api/v2.2/vehicle/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "header": {
    "num_results": 123,
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "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
    }
  ]
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

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

200

application/json

Successful retrieval of the vehicle summaries.

header · API Header Paginated · object · required

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

Show child attributes

data · Vehicle Summary · object[] · required

Show child attributes