Retrieve Distances

Retrieve a list of distances in a organization or subset of an organization.

SecuritybearerAuth
Request
query Parameters
deviceIdentifier
string or null

Filter by Device Identifier.

Example: deviceIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
groupIdentifier
string or null

Filter by Group Identifier.

Example: groupIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
vehicleIdentifier
string or null

Filter by Vehicle Identifier.

Example: vehicleIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
includeSubGroups
boolean

Include Sub Groups.

Example: includeSubGroups=false
limit
integer or null

Number of records to return.

Example: limit=100
offset
integer or null

Record to start with.

Example: offset=1500
startDate
string <date-time>

Filter by start date.

Example: startDate=2023-06-01
endDate
string <date-time>

Filter by end date.

Example: endDate=2023-07-01
sort
string or null

Name of the property to sort on.

Example: sort=VehicleName
order
string or null

Sort direction.

Example: order=asc
Responses
200

Ok

400

Bad Request

401

Unauthorized.

403

Forbidden

404

Not Found

500

Internal Server Error.

get/v1/distances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "metadata": [
    ]
}
© 2023 Lytx, Inc. All rights reserved