Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

post/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/list-positions

Path parameters

DeviceIdstring required

The device whose position history you want to retrieve.

TrackerNamestring required

The tracker resource receiving the request for the device position history.

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Request body

EndTimeExclusivestring date-time
<p>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time that the request is made.</p> <p>Requirement:</p> <ul> <li> <p>The time specified for <code>EndTimeExclusive</code> must be after the time for <code>StartTimeInclusive</code>.</p> </li> </ul>
MaxResultsinteger
<p>An optional limit for the number of device positions returned in a single call.</p> <p>Default value: <code>100</code> </p>
NextTokenstring
<p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </p> <p>Default value: <code>null</code> </p>
StartTimeInclusivestring date-time
<p>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours prior to the time that the request is made.</p> <p>Requirement:</p> <ul> <li> <p>The time specified for <code>StartTimeInclusive</code> must be before <code>EndTimeExclusive</code>.</p> </li> </ul>

Response

Success

NextTokenstring

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.