Skip to main content
GET
Positions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string<date>
default:2024-03-26

Path Parameters

device_id
string<uuid>
required

Device ID of the Positions to be returned

Query Parameters

start_time_utc
string<date-time>

Start time from when the data will be returned. Format: yyyy-MM-ddThh:mm:ss

end_time_utc
string<date-time>

End time from when the data will be returned. Format: yyyy-MM-ddThh:mm:ss

verify_data_collection
boolean
default:false

Verify data collection status. If true, checks data collection jobs for the time period and fails with a 424 status if any jobs have failed or are still running.

include_osm_road_classification
boolean
default:false

Return road name and distance from the road centreline for points which lie on a road. Values are null if the point is not on a road.

page
integer
default:0

Page number for pagination (zero-indexed)

Required range: x >= 0

Response

Successful Response

data
PointWithFeatures · object[]
required

Successful response payload