Telemetry API
API change history
A collection of RESTful JSON-based data operations used to retrieve vehicle and account data from your telematics solution. NOTE: when using OAUTH2.0, add "Bearer " before your token in the Authorization header.
Reports
Any Report within the app can be run via the API. Get report data for the specified Report, Assets, Groups or Hierarchy, and a Date Range.
Try itRequest
Request URL
Request headers
-
string
** Authorization Token is Required.
-
string
** Required. 3 character Environment Code.
-
(optional)stringMedia type of the body sent to the API.
Request body
| Report Name | report | type | Parameters |
|---|---|---|---|
| Activity Detail | activitydetail | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Activity Detail (AEMP) | activitydetailconstructionaemp | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Activity Detail Construction | activitydetailconstruction | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Alert Detail | alertdetail | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,alerts,shift |
| Asset Utilization By Hour | assetutilizationbyhour | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date |
| Begin/End Day | beginendday | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date |
| Driver Safety Summary | driversafetysummary | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Driver Safety Detail | driversafetydetail | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Assets and Drivers | assetsanddrivers | Asset, Group, Project, Hierarchy, or Company | report,type,id |
| DTC - Diagnostic Trouble Codes | checkenginedtc | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date |
| Engine Hours by Asset | enginehoursbyasset | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Engine Hours by Day | enginehoursbyday | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Fleet Summary | fleetsummary | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Fuel Efficiency | fueleconomy | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date |
| Fuel Usage | fuelusage | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date |
| Idle Report | idlereport | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Idle By RPM | idlerpmreport | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,rpm,shift |
| Job Site Utilization | jobsiteutilization | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,location,shift |
| Job Site Utilization By Week | jobsiteutilizationbyweek | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,location,shift |
| Location Duration | locationduration | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,location,durationHoursThreshold |
| Maintenance Status | maintenancestatus | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id |
| Proximity | proximity | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,location,shift,distance |
| Sensors (Binary) | sensors | Asset, Group, Project, Hierarchy, or Company | report,type,id,date |
| Start Stop Report | startstop | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| State Mileage | statemileage | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date,shift |
| Temperature Sensor | tempsensor | Asset, Driver, Group, Project, Hierarchy, or Company | report,type,id,date |
Parameter explanations
report (required): report from above table e.g. report:"activitydetail"
type (required): type from above table e.g. type:"Asset" or type:"Group" or "Company"
id (required): Comma separated list of Asset IDs, Driver IDs, Group IDs, Project IDs or Hierarchy Customer IDs
date (required): Comma separated start and end DateTime Range e.g. date:"12/13/17+00:00,12/13/17+23:59"
location: Comma separated list of Location IDs
alerts: Comma separated list of Alert IDs (idAlert) for Alert Reports
rpm: RPM for Idle by RPM Reports
distance: Proximity report - distance from location in users unit of measure (miles or km)
durationHoursThreshold: Location Duration report - number of hours in a Location
shift: 3 comma separated values: Shift Start Time, Shift EndTime, 0 (Not Enabled) or 1 (Enabled) e.g. shift:"10:00:00,16:00:00,1"
{
"report": "activitydetail",
"type": "asset",
"id": "1234,1798",
"date": "12/07/2017,12/08/2017"
}{
"example": {
"id": "1813,1798",
"date": "12/07/2017,12/08/2017"
}
}Responses
200 OK
Representations
{
"Summary": [
{
"Group_Name": null,
"Asset_Label": "Truck 001",
"GPS_Distance": 15.907142058235054,
"Motion_Duration": 2902,
"Stop_Duration": 47748,
"Idle_Duration": 355,
"Engine_On_Duration": 3257,
"Engine_Fuel_Consumed": null,
"Engine_Distance": null,
"Last_Engine_Hours": null,
"Estimated_Engine_Hours": 954.7625,
"Estimated_GPS_Odometer": 62324.948608746447
},
{
"Group_Name": null,
"Asset_Label": "Truck 002",
"GPS_Distance": 11.060434712366563,
"Motion_Duration": 1701,
"Stop_Duration": 53291,
"Idle_Duration": 127,
"Engine_On_Duration": 1828,
"Engine_Fuel_Consumed": null,
"Engine_Distance": null,
"Last_Engine_Hours": null,
"Estimated_Engine_Hours": 3113.4,
"Estimated_GPS_Odometer": 117195.60000000002
}
],
"Detail": [
{
"Group_Name": null,
"Asset_Label": "Truck 001",
"Event_Timestamp": "2019-09-12T13:18:47Z",
"Event_Date": "09/12/2019",
"Event_Time": "1:18 PM CDT",
"Event_Description": "Running",
"Latitude": 42.0339357,
"Longitude": -87.6743754,
"GPS_Speed": 0,
"Heading": 310,
"Heading_Cardinal": "NW",
"Address_Line2": "123 Main St Chicago, IL",
"Locality": "Chicago",
"Region": "IL",
"Postal_Code": "60652",
"County": "Cook County",
"Landmark_Name": null,
"GPS_Distance": null,
"Engine_On_Duration": null,
"Motion_Duration": null,
"Stop_Duration": null,
"Idle_Duration": null,
"Engine_Fuel_Consumed": null,
"Engine_Distance": null,
"GPS_Odometer": null,
"Odometer_Offset": null,
"Estimated_GPS_Odometer": 62298.415992891496,
"Last_Engine_Time_Offset": null,
"Estimated_Engine_Hours": 953.3411111111111,
"idAsset": 1234,
"Serial_Number_Displayed": "0987654321",
"VIN": "1234567890A98",
"EquipmentId": "1234567890"
}
]
}Code samples
@ECHO OFF
curl -v -X POST "https://temeda.azure-api.net/telemetry/reports"
-H "Authorization: "
-H "EnvironmentCode: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("EnvironmentCode", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://temeda.azure-api.net/telemetry/reports?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://temeda.azure-api.net/telemetry/reports");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Authorization", "");
request.setHeader("EnvironmentCode", "");
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://temeda.azure-api.net/telemetry/reports?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("EnvironmentCode","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://temeda.azure-api.net/telemetry/reports";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"EnvironmentCode"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://temeda.azure-api.net/telemetry/reports');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'EnvironmentCode' => '',
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Authorization': '',
'EnvironmentCode': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('temeda.azure-api.net')
conn.request("POST", "/telemetry/reports?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Authorization': '',
'EnvironmentCode': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('temeda.azure-api.net')
conn.request("POST", "/telemetry/reports?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://temeda.azure-api.net/telemetry/reports')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['EnvironmentCode'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body