v1/location_services

Use the v1/location_services API to retrieve Enhanced Location Services data reported by the device. A device uploads Enhanced Location Services data only if the device is subscribed to the service.

The bulk/history API returns at most 20,000 records and sets the Truncated HTTP header if the data is truncated. Use the start_time and end_time parameters to limit the data returned.

URI

http://<hostname>/ws/v1/location_services

Formats

Method Format Description Parameters
GET /ws/v1/location_services Get a summary of the location_services APIs. None
GET /ws/v1/location_services/bulk/history/{device_id} Get historical data for a device in CSV format. order start_time end_time timeline fields
GET /ws/v1/location_services/history/{device_id} Get the history for a device. order cursor size start_time end_time timeline

Location Services Fields

id

The location data point identifier

device_id

The device ID

customer_id

The customer ID of the account owning the data

timestamp

Date and time the current value was set.

server_timestamp

Date and time the current value was received.

system_uptime

The device uptime at the time of the data

latitude

The device latitude at the time of the data point

longitude

The device longitude at the time of the data point

altitude

The device altitude at the time of the data point

gps_satellites

The number of GPS satellites used to determine the location

gps_quality

The GPS quality indicator

gps_hdop

The GPS horizontal dilution of precision

modem_name

The first modem’s name

modem_state

The first modem’s state

modem_active_sim

The first modem’s active SIM

modem_bars

The first modem’s bars

modem_band

The first modem’s band

modem_network_technology

The first modem’s network technology

modem_apn

The first modem’s APN

modem_rssi

The first modem’s RSSI

modem_rsrq

The first modem’s RSRQ

modem2_name

The second modem’s name (if present)

modem2_state

The second modem’s state (if present)

modem2_active_sim

The second modem’s active SIM (if present)

modem2_bars

The second modem’s bars (if present)

modem2_band

The second modem’s band (if present)

modem2_network_technology

The second modem’s network technology (if present)

modem2_apn

The second modem’s APN (if present)

modem2_rssi

The second modem’s RSSI (if present)

modem2_rsrq

The second modem’s RSRQ (if present)

Parameters

Name Type Description
cursor string Cursor to get the next page of data. Omit on initial call.
end_time timestamp End time (exclusive) in ISO 8601 or epoch (long).
fields string Comma-separated list of fields to return for bulk API
order string Return data ordered by time (asc | desc). The default is ascending (asc).
size integer Number of items to return. The maximum and default is 1000
start_time timestamp Start time (inclusive) in ISO 8601 or epoch (long).
timeline string Timestamps to use in the request: client or server. The default is client.