Cloud Services API ReferenceAdvanced Device ServicesLocation-Based ServiceHistorical TrackGet Device Track Segment

Get Device Track Segment

Last Updated on : 2023-06-20 14:52:23download

Get device track segments on pages. The period between the end time and the start time is less than or equal to 7 days. A maximum of 1,000 track segments can be returned at a time. If the number of track segments in the time period is greater than 1,000, the first 1,000 track segments and the starting ID of the page for the next query will be returned.

API address

GET: /v2.0/iot-01/tracks/segments

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	query	true	The device ID.
start_time	Long	query	true	The 13-bit timestamp of the start time.
end_time	Long	query	true	The 13-bit timestamp of the end time.
last_id	Long	query	false	The starting ID of the next page. The value is empty for the first request.

Return parameter

Parameter name	Type	Description
result	TrackSegmentRes

Description of result

Parameter name	Type	Description
device_id	String	The device ID.
segment_list	List	The list of track segments in descending order of time.
last_id	Long	The starting ID of the next page.
has_more	Boolean	Specifies whether to return the next page. If the total number of track points is less than 1,000, it is the last page and the value is `true`. Otherwise, it is `false`.

Description of segment_list

Parameter name	Type	Description
start_time	Long	The 13-bit timestamp of the start time.
end_time	Long	The 13-bit timestamp of the end time.
duration	Long	The duration of a segment. Unit: seconds.
speed	Double	The speed. Unit: kilometers/hour. The magnification conversion has been completed.
mileage	Double	The mileage of a segment. Unit: kilometers. The magnification conversion has been completed.
battery	Integer	The power consumption of a segment. Valid values: an integer from 0 to 100.

Request example

GET: /v2.0/iot-01/tracks/segments?device_id=vdevo16245017293****&start_time=1625198100154&end_time=1625198190154

Return example

{
    "result": {
        "device_id": "vdevo16245017293****",
        "segment_list": [
            {
                "end_time": 1625198190154,
                "battery": 5,
                "speed": 100,
                "duration": 3000,
                "start_time": 1625198100154,
                "mileage": 10
            }
        ],
        "has_more": false
    },
    "t": 1625736304038,
    "success": true
}

Error code

For more information, see error code.

Prev DocHistorical Track

Next DocGet Device Track Point