Skip to content

Retrieving Events

All available event data may be retrieved via a "universal" events API.

All events generated by the TN360 platform may be retrieved via this universal RESTful API.
The API returns events in the most performant way possible, which means the related entities are not included in the result. The various entity identifiers (eg company ID, vehicle ID, device ID etc) are returned, but must be resolved independently (or prior) to this API call.

Info

The current default date range for an event query is 1 day (ie. last 24 hours from the current time).
The current maximum date range for an event query is 7 days.

Examples

Note: these examples use a fake API key

Using the multi 'type' API

This API allows the full range of supported event entities to be extracted in a generic fashion. This allows a client to simply specify the event 'types' they are interested in, and select those events for the nominated date range.

Additionally, other criteria are additionally constraining. So listing specific fleet ID's, or vehicle ID's will further constrain the result to only those entities listed.

Tip

Please use the most constraints possible to restrict the result set as much as possible. This greatly improved system performance and response times. The more criteria possible, the faster and more efficient the system will respond.

$ curl -s -H 'Content-Type: application/json'  \
       -H 'Authorization: Bearer ea9ad5fcddd943d1870cafaa5c394d1c' \
    'https://stg.api-au.telematics.com/v1/events?types=ignition,driver&from=2024-11-01&to=2024-11-02'
 [ {
  "id" : 49795859,
  "companyId" : 930,
  "deviceId" : 34380,
  "vehicleId" : 2456291,
  "tripId" : 13208647,
  "type" : "ignition",
  "action" : "ON",
  "location" : "84 Old North Road, Kumeū 0892, New Zealand",
  "timeAt" : 1730394473000,
  "createdAt" : "2024-11-01T04:08:34.734+11:00",
  "odometer" : 31363.05,
  "origin" : "hermes",
  "attributes" : {
    "seq" : "4191",
    "status" : "E"
  },
  "GPS" : {
    "valid" : true,
    "Lat" : -36.77986,
    "Lng" : 174.57951,
    "At" : 1730394473000
  }
}, {
  "id" : 49795860,
  "companyId" : 930,
  "companyVersion" : 10,
  "deviceId" : 67233,
  "deviceVersion" : 13,
  "vehicleId" : 2497703,
  "vehicleVersion" : 678,
  "tripId" : 13208648,   
  "type" : "driver",
  "action" : "Work",
  "location" : "84 Old North Road, Kumeū 0892, New Zealand",

...[snip]...

Using the single 'type' API

If you are only interested in a certain 'type' of event (eg 'ignition' events) it may be simpler to just query against this API. Internally we forward with request to the same logic as the multi-type API, buit with the 'type' preset to the selected value.

$ curl -s -H 'Content-Type: application/json'  \
       -H 'Authorization: Bearer ea9ad5fcddd943d1870cafaa5c394d1c' \
    'https://stg.api-au.telematics.com/v1/events/ignition?from=2024-11-01&to=2024-11-02'
[ {
  "id" : 49795859,
  "companyId" : 930,
  "deviceId" : 34380,
  "vehicleId" : 2456291,
  "tripId" : 13208647,
  "type" : "ignition",
  "action" : "ON",
  "location" : "84 Old North Road, Kumeū 0892, New Zealand",
  "timeAt" : 1730394473000,
  "createdAt" : "2024-11-01T04:08:34.734+11:00",
  "odometer" : 31363.05,
  "origin" : "hermes",
  "attributes" : {
    "seq" : "4191",
    "status" : "E"
  },
  "GPS" : {
    "valid" : true,
    "Lat" : -36.77986,
    "Lng" : 174.57951,
    "At" : 1730394473000
  }
}, {
  "id" : 49795860,
  "companyId" : 930,
  "deviceId" : 67233,
  "vehicleId" : 2497703,
  "tripId" : 13208648,
  "type" : "ignition",
  "action" : "ON",
  "location" : "84 Old North Road, Kumeū 0892, New Zealand",
  "timeAt" : 1730394496000,

...[snip]...

Using the direct event ID API

Where an event 'type', id' and event 'time' are know, this API will locate the specific event. Again this is forwarded to the multi-type API with the constraints preset as a convenience.

$ curl -s -H 'Content-Type: application/json'  \
       -H 'Authorization: Bearer ea9ad5fcddd943d1870cafaa5c394d1c' \
      'https://stg.api-au.telematics.com/v1/events/ignition/49795860?from=2024-11-01&to=2024-11-02'
{
  "id" : 49795860,
  "companyId" : 930,
  "deviceId" : 67233,
  "vehicleId" : 2497703,
  "tripId" : 13208648,
  "type" : "ignition",
  "action" : "ON",
  "location" : "84 Old North Road, Kumeū 0892, New Zealand",
  "timeAt" : 1730394496000,
  "createdAt" : "2024-11-01T04:08:59.851+11:00",
  "odometer" : 1743.04,
  "origin" : "hermes",
  "attributes" : {
    "canOdometer" : "142511",
    "canEngineHours" : "137.25999450683594",
    "seq" : "6373",
    "status" : "E"
  },
  "GPS" : {
    "valid" : true,
    "Lat" : -36.77989,
    "Lng" : 174.57956,
    "At" : 1730394496000
  }
}