Contact us Login LIVE DEMO FREE TRIAL

list(…)

Get a list of track descriptions for the specified tracker and time period.

parameters:

name description type
tracker_id Id of the tracker (aka “object_id”). Tracker must belong to authorized user and must not be blocked. int
from A string containing date/time in “yyyy-MM-dd HH:mm:ss” format (in user’s timezone) String
to A string containing date/time in “yyyy-MM-dd HH:mm:ss” format (in user’s timezone). Specified date must be after “from” date String
filter (optional, default=true) If true, tracks which are too short (in terms of length and number of points) will be omitted from resulting list. boolean
split (optional, default=true) If false, all tracks will be merged into single one. boolean
include_gsm_lbs (optional, default=true) If false, GSM LBS tracks will be filtered out. boolean
cluster_single_reports (optional, default=false) If true, single point reports will be clustered by its coordinates. boolean
count_events (optional, default=false) If true, number of events occurred during each non-singlepoint track will be returned. boolean

return:

{
    "success": true,
    "limit_exceeded": <true if requested time period exceeds limit specified in tracker's tariff>, //boolean
    "list": [ <track_info>, ... ] //list of zero or more JSON objects
}

where <track_info> is either <regular>, <single_report> or <merged>:

    <regular> = 
    {
        "id": <track id>, //int
        "start_date": <track start date, in user`s timezone e.g. "2011-06-18 03:39:44">,  //string
        "start_address": <track start address>, //string
        "max_speed": <maximum speed in km/h, e.g. 96>, //int
        "end_date": <track end date, in user`s timezone e.g. "2011-06-18 05:18:36">,  //string
        "end_address": <track end address>, //string
        "length": <track length in kilometers, e.g. 85.5>, //float
        "points": <total number of points in track, e.g. 724>,  //int
        "avg_speed": <average speed in km/h, e.g. 70>,  //int
        "event_count": 3, //number of events on this track. Field is omitted if "count_events" is "false"
        "norm_fuel_consumed": 11.07, //consumed fuel on track, litres. Field is omitted if no vehicle binded to tracker or no normAvgFuelConsumption defined in vehicle
        "type": "regular"  //used to distinguish this track type from the others,
        "gsm_lbs": <GSM LBS point flag, optional>  //boolean
    } 

    <single_report> = //returned if device was creating reports in "interval" mode (e.g. M7 tracker in interval mode)
    {
        "id": <track id>, //int
        "type": "single_report", //used to distinguish this track type from the others
        "start_date": <point creation date in user`s timezone e.g. "2011-06-16 15:35:01">,
        "start_address": <point address>, //string
        "avg_speed": <point speed in km/h, e.g. 34>  //int
        "gsm_lbs": <GSM LBS point flag, optional>,  //boolean
        "precision": <location precision, meters, optional>,  //int
    }

    <merged> =   //only returned if "split" is set to "false"
    {
        "start_date": <track start date, in user`s timezone e.g. "2011-06-18 03:39:44">,  //string
        "start_address": <track start address>, //string
        "max_speed": <maximum speed in km/h, e.g. 96>, //int
        "end_date": <track end date, in user`s timezone e.g. "2011-06-18 05:18:36">,  //string
        "end_address": <track end address>, //string
        "length": <track length in kilometers, e.g. 85.5>, //float
        "points": <total number of points in track, e.g. 724>,  //int
        "avg_speed": <average speed in km/h, e.g. 70>,  //int
        "event_count": 3, //number of events on this track. Field is omitted if "count_events" is "false"
        "norm_fuel_consumed": 11.07, //consumed fuel on track, litres. Field is omitted if no vehicle binded to tracker or no normAvgFuelConsumption defined in vehicle
        "type": "merged"  //used to distinguish this track type from the others,
        "gsm_lbs": <GSM LBS point flag, optional>  //boolean 
    }

    <cluster> =   //only returned if "split" is set to "true"
    {
        "start_date": <track start date, in user`s timezone e.g. "2011-06-18 03:39:44">,  //string
        "start_address": <track start address>, //string
        "end_date": <track end date, in user`s timezone e.g. "2011-06-18 05:18:36">,  //string
        "precision": <radius in meters, e.g. 500>, //int
        "points": [<array of points in cluster, {"lat": 56.829279,"lng": 60.597123}>],  //array of points
        "type": "cluster"  //used to distinguish this track type from the others,
        "gsm_lbs": <GSM LBS flag, true if cluster contains only GSM LBS points>,  //boolean 
    }

errors:

  • 204 – Entity not found (if there is no tracker with such id belonging to authorized user)
  • 208 – Device blocked (if tracker exists but was blocked due to tariff restrictions or some other reason)
  • 211 – Requested time span is too big (if interval between “from” and “to” is too big (maximum value is specified in API config)

If you have more questions please contact our support team

Contacts

USA: +1 858 815 9045

Mexico: +52 334 1642158

UK: +44 808 1641499

Germany: +49 1573 5988250

Russia: +7 495 223 0427

Log in

Login

[clean-login]

CLOSE
Register

[clean-login-register]

CLOSE
Loading...