v1
latestOpenAPI 3.1.02026-08-0411088114.2 KBlocation
Ping Location
post/users/me/location
Request body
device_typestring required
(browser, mobile_ios, mobile_android, sms)
user_idstring required
ID of the user this location belongs to
timestampstring date-time required
Client-reported timestamp of the location
server_timestampstring date-time
Server-recorded timestamp of when data was received
latitudenumber nullable
Latitude coordinate
longitudenumber nullable
Longitude coordinate
accuracynumber nullable
Accuracy of the location in meters
altitudenumber nullable
Altitude in meters
speednumber nullable
Speed in meters per second
headingnumber nullable
Direction of travel in degrees
device_idstring nullable
Unique identifier for the device
addressstring nullable
Generic address string representation of the location
timezonestring nullable
Timezone identifier for the location
app_versionstring nullable
Version of the client application
additional_dataobject nullable
Flexible container for any additional data provided by specific clients
Response
Successful Response