Track locations of an asset
Changed onRequest
- Base URLhttps://api.nextbillion.io
- AuthAPI key in query parameter key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of the asset for which the location track information needs to be retrieved. This is the same ID that was generated/provided at the time of creating the asset.
Query parameters
A key is a unique identifier that is required to authenticate a request to the API.
Time after which the tracked locations of the asset need to be retrieved.
Time until which the tracked locations of the asset need to be retrieved.
geometry format to encode the path linking the tracked locations of the asset.
Set the geometry format to encode the path linking the tracked locations of the asset.
Please note that geometry_type is effective only when mapmatch property of correction parameter is set to 1.
Describe the geometry characteristics through a , separated list of properties.
Setting mapmatch to 1 returns the geometry of the tracked points, snapped to the nearest road.
Setting interpolate to 1 smoothens the snapped geometry by adding more points, as needed. Please note, mapmatch should be set to 1 for interpolate to be effective.
mode is used to set the transport mode for which the snapped route will be determined. Allowed values for mode are car and truck.
Denotes page number. Use this along with the ps parameter to implement pagination for your searched results. This parameter does not have a maximum limit but would return an empty response in case a higher value is provided when the result-set itself is smaller.
Denotes number of search results per page. Use this along with the pn parameter to implement pagination for your searched results.
Response
OK
Changes
- breaking
for the
queryrequest parametercorrection, default value was changed frommapmatch=0,interpolate=0,mode=cartomapmatch=0,interpolate=0,mode=car - breaking
removed the enum value
geojsonfrom thequeryrequest parametergeometry_type - breaking
removed the enum value
polyline6from thequeryrequest parametergeometry_type - breaking
removed the enum value
polylinefrom thequeryrequest parametergeometry_type - info
added the new enum value
geojsonto thequeryrequest parametergeometry_type - info
added the new enum value
polylineto thequeryrequest parametergeometry_type - info
added the new enum value
polyline6to thequeryrequest parametergeometry_type
- breaking
- breaking
for the
queryrequest parametercorrection, default value was changed frommapmatch=0,interpolate=0,mode=cartomapmatch=0,interpolate=0,mode=car - breaking
removed the enum value
geojsonfrom thequeryrequest parametergeometry_type - breaking
removed the enum value
polylinefrom thequeryrequest parametergeometry_type - breaking
removed the enum value
polyline6from thequeryrequest parametergeometry_type - info
added the new enum value
geojsonto thequeryrequest parametergeometry_type - info
added the new enum value
polyline6to thequeryrequest parametergeometry_type - info
added the new enum value
polylineto thequeryrequest parametergeometry_type
- breaking