| Field Name |
Name |
Type |
Description |
Fixed Values |
| href |
URL |
STRING() |
Absolute URL of the resource |
|
| id |
id |
INTEGER() |
Unique identifier of the resource |
|
| number |
number |
INTEGER() |
The asset number for the site |
|
| organization |
organization |
ARRAY() |
The owner of the route |
|
| organization - href |
organization - URL |
STRING() |
Absolute URL of the resource |
|
| organization - id |
organization - id |
INTEGER() |
Unique identifier of the resource |
|
| enabled |
enabled |
BOOLEAN() |
Disabled routes do not generate statistics |
|
| draft |
draft |
BOOLEAN() |
Draft routes may be awaiting user confirmation of its configuration |
|
| name |
name |
STRING() |
Descriptive name up to 200 characters |
|
| beacon_index |
beacon_index |
INTEGER() |
The system assigned broadcast identifier for the site |
|
| ios_name |
ios_name |
STRING() |
Descriptive name written phonetically so that is correctly spoken in the iOS smartphone app. Not for displaying visually |
|
| android_name |
android_name |
STRING() |
Descriptive name written phonetically so that is correctly spoken in the Android smartphone app. Not for displaying visually |
|
| location |
location |
GEOPOINT() |
The location of the site using world coordinates |
|
| broadcast_travel_times |
broadcast_travel_times |
ARRAY() |
A list of broadcast travel times that can transmit from the site |
|
| devices |
devices |
ARRAY() |
A list of devices that are collecting data at the site |
|
| devices - href |
devices -ID |
STRING() |
Absolute URL of the resource |
|
| devices - id |
devices - id |
INTEGER() |
Unique identifier of the resource |
|
| is_licensed |
is_licensed |
BOOLEAN() |
Is this site licensed |
|
| latest_stats |
latest_stats |
OBJECT() |
Unique probe detection statistics for the last 5-minute interval generated |
|
| latest_stats - interval_start |
latest_stats - interval_start |
TIMESTAMP() |
The start time of the current statistical interval |
|
| latest_stats - probe_count |
latest_stats - probe_count |
INTEGER() |
The number of unique probes detected during the current 5-minute interval |
|
| latest_stats - raw_probe_count |
latest_stats - raw_probe_count |
INTEGER() |
The number raw probe records detected during the current 5-minute interval |
|
| latest_stats - estimated_event_count |
latest_stats - estimated_event_count |
INTEGER() |
The number of estimated events created during the current 5-minute interval |
|
| latest_stats - average_duration |
latest_stats - average_duration |
INTEGER() |
The average time between the first and last time stamp for probes passing through this site during the current 5-minute interval |
|
| latest_raw_stats |
latest_raw_stats |
OBJECT() |
Probe detection statistics for the last 15-second interval generated |
|
| latest_source_id_type_stats |
latest_source_id_type_stats |
OBJECT() |
Unique probe detection statistics per source id type for the last 5-minute interval generated |
|
| latest_active_time_in_range_stats |
latest_active_time_in_range_stats |
OBJECT() |
Probe detection statistics over the last minute for probes currently in range of the Site |
|
| broadcast_message |
broadcast_message |
STRING() |
The current message being broadcast at the site as a string |
|
| beacon_stats |
beacon_stats |
OBJECT() |
The identifier of the current message being broadcast at the site |
|
| broadcast_travel_time |
broadcast_travel_time |
OBJECT() |
The broadcast travel time message that is active on the current site |
|
| beacon_events |
beacon_events |
ARRAY() |
A list of beacon events that are relevant to the current site |
|
| incidents |
incidents |
ARRAY() |
A list of incidents that are relevant to the current site |
|
| ibeacon_data |
ibeacon_data |
OBJECT() |
The current iBeacon Parameters being broadcast at a site |
|
