REQUEST
Start timestamp in milliseconds (Unix epoch). Required.Defines the beginning of the time range for track retrieval.Example:
1634567890000
(October 18, 2021)End timestamp in milliseconds (Unix epoch). Required.Defines the end of the time range for track retrieval.Example:
1634654290000
(October 19, 2021)Array of member UIDs to retrieve tracks for. Recommended format.
- If provided: Returns tracks for specified members only
- If omitted: Uses legacy
accounts
parameter
["abc123", "def456"]
Legacy parameter. Array of UIDs or usernames. Use
uids
instead for new integrations.Example: ["worker1@company.com", "worker2uid"]
Include detailed course/heading information in encoded format.
true
: Addscourse_encoded
field with directional datafalse
: No course data (smaller response)
Permissions
- Must have view permissions for the requested members
- Can only retrieve tracks for members in your organization or network
- Company members can view employee tracks based on their role
RESPONSE
Modern format (when usinguids
):
accounts
):
Status code.
0
indicates success.(Modern format) Flat array of all track entries from all requested members.
(Legacy format) Object with keys as UIDs/usernames, values as arrays of track entries for that member.
Track Entry Structure
Each track entry contains: Identity & Type:id
(long): Unique track entry identifierowner_uid
(string): UID of the member who recorded this trackkind
(string): Entry type, typically “track_entry”labels
(integer): Label flags/categories
start_ts
(long): Track start timestamp in millisecondsend_ts
(long): Track end timestamp in milliseconds
start_lat
(double): Starting latitudestart_lng
(double): Starting longitudeend_lat
(double): Ending latitudeend_lng
(double): Ending longitude
distance
(double): Total distance traveled in meterswaypoint_count
(integer): Number of GPS waypoints recorded
speed_avg
(double): Average speed in meters per secondspeed_max
(double): Maximum speed in meters per second
altitude_min
(integer): Minimum altitude/elevationaltitude_max
(integer): Maximum altitude/elevationaltitude_gain
(integer): Total elevation gain in metersaltitude_loss
(integer): Total elevation loss in meters
short_encoded
(string): Polyline-encoded GPS path (Google Polyline format)course_encoded
(string): Encoded heading/direction data (ifwithCourse: true
)
lat_min
,lat_max
(double): Latitude bounding boxlng_min
,lng_max
(double): Longitude bounding box
share_url
(string): Public shareable URL for this track
Use Cases
Mileage Reporting: Sumdistance
values across tracks for reimbursement or tax reporting.
Route Analysis:
Decode short_encoded
polyline to visualize actual paths taken.
Performance Monitoring:
Analyze speed_avg
and distance
to evaluate worker efficiency.
GPS Breadcrumbs:
Use waypoint_count
and encoded paths to replay historical movements.
Examples
Timestamps: All timestamps are in milliseconds since Unix epoch (January 1, 1970 UTC). This is the standard Java/JavaScript timestamp format.
Polyline Encoding: The
short_encoded
field uses Google’s Polyline Encoding Algorithm. You can decode this using standard libraries to get the full GPS path with all waypoints.Distance Units: All distances are in meters. Divide by 1000 to get kilometers, or multiply by 0.000621371 to get miles.
Speed Units: All speeds are in meters per second. Multiply by 3.6 for km/h or by 2.23694 for mph.
Related Endpoints
- Locate - Get current real-time locations
- Create Report - Generate mileage and activity reports
- Get Members - Retrieve member information