Get an entity's data
Browse a vehicle's generated events
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | start date YYYY-MM-DD[Thh:mm:ss] | |
to | string | end date YYYY-MM-DD[Thh:mm:ss], defaults to current time | |
duration | string | ISO_8601 Duration format (PnYnMnDTnHnMnS, PnW, PT) (ex: P1D = Past 1 Day) | |
entities | string | Vehicles or assets ids | |
vehicles | number | Vehicles to search, if not provided looks up all of the users vehicles (json array or csv) | |
assets | number | Asset ids | |
groups | number | Groups to search for (json array or csv) | |
fields | string | Fields to include (json array or csv) - for more info see platform's resource rawdata fields | |
exclude | string | Fields to exclude (json array or csv) | |
types | null | Event types to search for (json array or csv) | |
labels | null | Event labels to search for (json array or csv) - for a list of available labels click here: Spreadsheet - labels | |
codes | null | Event codes es to search for (json array or csv) | |
filter | null | Filter to run on the results ex (dev_dist > 0 and gps_valid) | |
resample | null | Normalize data sets to evenly timed chunks | |
freq | null | How to resample the data |
Allowed values: sum, mean, std, sem, max, min, median, first, last, diff |
| group_by
| null | | Group by (ex: vid, ignon) |
| fill
| null | | Fill in gaps between data sets (forward fill, back fill, padding)
Allowed values: ffill, bfill, pad |
| distance
| null | | Unit to return distance values in
Default value: meter
Allowed values: meter, km, mile, user |
| time
| null | | Unit to return time values in
Default value: second
Allowed values: second, hour, minute, day |
| speed
| null | | Unit to return speed values in
Default value: mph
Allowed values: mph, kph, user |
| volume
| null | | Unit to return volume values in
Default value: liter
Allowed values: liter, gallon, user |
| tz
| null | | Timezone |
| order
| null | | Order the results by a particular field (place a '-'' in front for reverse ordering) (ex: rssi, -speed) |
| head
| null | | Get top 'n' events from result |
| tail
| null | | Get bottom 'n' events from result |
| round
| null | | Round decimal numbers to n digits |
| orient
| null | | Format the json response
Allowed values: columns, index, values, split |
| raw
| null | | Returns all floats as ints (lat, lon, hdop, pdop, vdop, ecu_idle_fuel, ecu_total_fuel) |
| export
| null | | Export result
Default value: json
Allowed values: json, html, csv, tsv |
| async
| boolean | | Delegate request to a Job, returns Job ID, use jobs api to retrieve data |
| slice
| null | | Break up the request into slices (for very large data sets) |
RESPONSES
status: OK
"event_time,id,system_time,vid,code,device_id,ecu_speed,ecu_speed_flag,hdop,head,label,lat,lon,mph,speed,sv,type,valid_position,ecu_distance,io_ign\n2023-09-22T06:36:57,82011573407955.0,2023-09-22T07:19:02.955073,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,1,10,0,,0\n2023-09-22T06:37:21,82011573409204.0,2023-09-22T07:19:04.204873,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,2,10,0,,0\n2023-09-22T06:37:44,82011573410395.0,2023-09-22T07:19:05.395035,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,2,10,0,,0\n2023-09-22T06:38:04,82011573411465.0,2023-09-22T07:19:06.465360,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,2,10,0,,0\n2023-09-22T06:38:28,82011573412705.0,2023-09-22T07:19:07.705458,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,2,10,0,,0\n2023-09-22T06:38:56,82011573413815.0,2023-09-22T07:19:08.815700,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,3,10,0,,0\n2023-09-22T06:39:30,82011573414946.0,2023-09-22T07:19:09.946163,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,3,10,0,,0\n2023-09-22T06:40:02,82011573415857.0,2023-09-22T07:19:10.857642,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,3,10,0,,0\n2023-09-22T06:40:46,82011573417025.0,2023-09-22T07:19:12.025264,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,3,10,0,,0\n2023-09-22T07:18:20,82011573418255.0,2023-09-22T07:19:13.255033,820,37,354442090113099,,,9.99,0,slpoff,32.2941,-64.78960000000001,0,0.0,1,10,0,,0\n2023-09-22T07:18:53,82011573419687.0,2023-09-22T07:19:14.687015,820,98,354442090113099,,,9.99,0,position,32.2941,-64.78960000000001,0,0.0,0,10,0,,0\n2023-09-22T07:24:05,82011573743352.0,2023-09-22T07:24:38.352872,820,37,354442090113099,,,1.6300000000000001,319,slpoff,32.26308,-64.86933,17,27.35878,5,10,1,,0\n2023-09-22T07:29:55,82011574092051.0,2023-09-22T07:30:27.051217,820,37,354442090113099,,,2.1,0,slpoff,32.29225,-64.87369000000001,25,40.2335,4,10,1,,0\n2023-09-22T07:32:39,82011574227986.0,2023-09-22T07:32:42.986804,820,1,354442090113099,,,1.43,158,trckpnt,32.30364,-64.86278,4,6.43736,6,10,1,,0\n2023-09-22T07:33:09,82011574256332.0,2023-09-22T07:33:11.332629,820,1,354442090113099,,,1.43,40,trckpnt,32.3034,-64.86271,4,6.43736,6,10,1,,0\n2023-09-22T07:44:37,82011574976630.0,2023-09-22T07:45:11.630732,820,37,354442090113099,,,9.99,0,slpoff,32.3033,-64.86339000000001,0,0.0,4,10,0,,0\n"