Cellular RF Metrics

GraphQL Type: cell_rf_metrics

RF Metrics are collected multiple times per hour and provide a snapshot of the RF environment at the time of sampling.

A single cell_rf_metrics record is created for every cell captured by the Kallo. This means a test for a single configuration may generate multiple cell_rf_metrics for any serving and neighbour cells advertising the configured PLMN, technology and band. You can use the serving_cell field to query only serving cells, and the dominant_cell field to query only the serving cell with the strongest signal.

Field	Type	Guaranteed	Description
band	smallint	True	3GPP Band Number NR: NR-ARFCN LTE: E-UTRA Operating Band Number UMTS: UTRA FDD Band Number
channel	integer		3GPP Channel Number NR: NR-ARFCN LTE: EARFCN UMTS: UARFCN
config_id	integer	True	Identifier of the configuration used to collect the data
cqi	integer		Channel Quality Indicator NR: Coming soon LTE: Available UMTS: Not available
dominant_cell	boolean	True	Indicates if the cell has the strongest signal out of all available serving and neighbor cells
ecno	float		Ratio between the received energy from the pilot signal CPICH per chip (Ec) to the noise density (No) (dB) NR: Not available LTE: Not available UMTS: Available
install_location	locations	True	A locations entry
install_location_id	integer		Identifier of the installation location where the data was collected
mcs	integer		Modulation and Coding Scheme NR: Coming soon LTE: Available UMTS: Not available
pci	integer		Physical Cell Identifier NR: Available LTE: Available UMTS: Not available
plmn	string	True	Public Land Mobile Network Identifier (MCC-MNC)
psc	integer		Primary Scrambling Code NR: Not available LTE: Not available UMTS: Available
pucch_txp	float		Physical Uplink Control Channel Transmit Power (dBm) NR: Coming soon LTE: Available UMTS: Not available
pusch_txp	float		Physical Uplink Shared Channel Transmit Power (dBm) NR: Coming soon LTE: Available UMTS: Not available
RSCP	float		Received Signal Code Power (dBm) NR: Not available LTE: Not available UMTS: Available
RSRP	float		Reference Signal Received Power (dBm) NR: Available LTE: Available UMTS: Not available
RSRQ	float		Reference Signal Received Quality (dB) NR: Available LTE: Available UMTS: Not available
serial_number	string	True	Serial number of the device that collected the data
serving_cell	boolean	True	Indicates if this cell was the serving cell during this RF test
signal	boolean	True	Indicates if the device was successfully able to connect to the carrier network on the given band. If false, the metrics will be null
sinr	float		Signal to Interference plus Noise Ratio (dB) NR: Available LTE: Available UMTS: Not available
site	`sites`		A sites entry
site_id	integer		Identifier of the site where the data was collected A site can contain multiple sub-sites and installation locations
sub_site	`sub_sites`		A sub_sites entry
sub_site_id	integer		Identifier of the sub-site where the data was collected A sub-site can contain multiple installation locations
ta	integer		Timing Advance NR: Coming soon LTE: Coming soon UMTS: Not available
task_index	smallint	True	Index of the configuration task that collected the data
technology	string	True	3GPP Technology NR: New Radio (5G) LTE: Long Term Evolution (4G) UMTS: Universal Mobile Telecommunications System (3G)
time	timestamp	True	RFC3339 timestamp of the data collection time - NOTE: expressed in UTC
txp	float		Transmitted Power (dBm) NR: Coming soon LTE: Not available UMTS: Available

Cellular Throughput Metrics

GraphQL Type: cell_throughput_metrics

Cellular throughput metrics provide the results of a data connection and throughput test to the server as configured. These tests are collected by default once every four hours for customers with this option.

A singular cell_throughput_metrics record is created for every test run on a Kallo. However, a subset of metrics recorded on each serving cell during the test is recorded in the cells field, or the associated cell_throughput_cells type.

Field	Type	Guaranteed	Description
bytes_download	bigint		Total number of bytes downloaded during this throughput test
bytes_upload	float		Total number of bytes uploaded during this throughput test
cells	`cell_throughput_cells`	True	An array relationship
config_id	integer	True	Identifier of the configuration used to collect the data
install_location	`locations`		A `locations` entry
install_location_id	integer		Identifier of the installation location where the data was collected
jitter_download	float		Download jitter in milliseconds
jitter_upload	float		Upload jitter in milliseconds
latency	float		Latency in milliseconds
max_download	float		Maximum download speed in bits per second
max_upload	float		Maximum upload speed in bits per second
plmn	string	True	Public Land Mobile Network Identifier (MCC-MNC)
serial_number	string	True	Serial number of the device that collected the data
signal	boolean	True	Indicates if the device was successfully able to connect to the carrier network. If false, the metrics will be null
site	`sites`		A `sites` entry
site_id	integer		Identifier of the site where the data was collected A site can contain multiple sub-sites and installation locations
sub_site	`sub_sites`		A `sub_sites` entry
sub_site_id	integer		Identifier of the sub-site where the data was collected A sub-site can contain multiple installation locations
task_index	smallint	True	Index of the configuration task that collected the data
time	timestamp	True	RFC3339 timestamp of the data collection time - NOTE: expressed in UTC

Events

GraphQL Type: events

An event is an occurrence of a significant event on a Kallo device. Events are generated by the Kallo device and may be delayed by a lack of connectivity. Events are generated for a variety of reasons, including power loss, hardware failure, and firmware update. A full list of represented events is available below.

Field	Type	Guaranteed	Description
event	event	True	The details of this event. The details available will differ on the value of the event_type field. Possible combinations are documented in the Event Types section below.
event_type	string	True	A string token denoting the type of this event. One of 'device_startup', or 'device_restart'. The details available will differ on the value of the `event_type` field. Possible combinations are documented in the Event Types section below.
install_location_id	integer		Identifier of the installation location where the event was triggered.
serial_number	string	True	Serial number of the device on which this event was triggered.
site_id	integer		Identifier of the site where the event was triggered. A site can contain multiple sub-sites and installation locations
sub_site_id	integer		Identifier of the sub-site where the event was triggered. A sub-site can contain multiple installation locations.
time	timestamp	True	RFC3339 timestamp of the time the event was triggered on the device - NOTE: expressed in UTC

Event Types

Device Startup

Generated when a device successfully completes its initial self-check and begins collecting data.

Event Type

device_startup

Event

Field	Type	Description
sims	`sims`	An array of sim objects describing the subscriber identity module cards inserted into this device. The SIMs are ordered and include any embedded SIMs mounted in the Kallo device, along with any smart card SIMs mounted in the SIM slots.

Sim Object

Each object describes either a embedded (MMF2) or micro (FF4) Subscriber Identity Module (SIM) in the Kallo device. If the SIM is a Embedded Universal Integrated Circuit Card (eUICC) SIM, the spn, imsi, hplmn and iccid fields will represent those properties of the active SIM profile at startup.

Field	Type	Description
spn	string	Service Provider Name - The name of the carrier provided by the SIM card.
imsi	string	International Mobile Subscriber Identity (IMSI) number of the SIM card.
hplmn	string	Home Public Land Mobile Network (HPLMN) identifier of the SIM card.
iccid	string	The Integrated Circuit Card Identification (ICCID) number of the SIM card.
eid	string	Embedded Universal Integrated Circuit Card (eUICC) Identifier - The identifier of the eUICC itself. Only filled for some eUICC SIMs.
dspn	string	Derived issuer Service Provider Name - The name of the issuer of the eUICC. Only filled for some eUICC issuers.

Device Restart

Generated immediately before a device restarts.

Event Type

device_restart

Event

Field	Type	Description
reason	string	The reason the device is restarting. Possible values and explanations are available in the reason values table below.

Reason Values

Value	Description
`RESTART_REASON_UNKNOWN`	This device was restarted for an unknown reason.
`RESTART_REASON_MAINTENANCE`	This device was restarted following periodic device maintenance.
`RESTART_REASON_FIRMWARE`	This device was restarted to undertake a firmware upgrade.
`RESTART_REASON_MODEM_FAULT`	This device was restarted as the modem encountered an unrecoverable error and needed to be restarted.
`RESTART_REASON_PUBLISH_FAILURE`	This device was restarted as the device was unexpectedly unable to publish data for an extended period.

Sites

GraphQL Type: sites

A site is a physical location where Kallo units are installed like a building or complex of buildings. Sites can have multiple sub_sites.

Field	Type	Guaranteed	Description
address_line1	string		Address line 1 of the site
address_line2	string		Address line 2 of the site
country	string		Country of the site
id	bigint		Unique identifier for the site
name	string		Site Name
postal_code	string		Postal code of the site
site_type	string		Type of site. One of 'building', 'stadium', 'compound', 'outdoor_location', or 'other'
sub_sites	`sub_sites`	True	An array relationship
suburb_city	string		Suburb or city of the site
zone	string		State, province, zone or region of the site

Sub-Sites

GraphQL Type: sub_sites

A sub-site is a physical location which forms part of a site where Kallo units are installed. Sub-sites can be floors, rooms, or even small buildings within a larger site. Each sub_sites record is associated with a parent site and can have multiple locations within it.

Field	Type	Guaranteed	Description
id	bigint		Unique identifier for the sub-site
locations	`locations`	True	An array relationship
name	string		Sub-site Name
site	sites		A `sites` entry
site_id	integer		Unique identifier for the site this sub-site is inside

Locations

GraphQL Type: locations

A location is a physical installation point for a Kallo unit. Each locations record is associated with a parent site and sub_site.

Field	Type	Guaranteed	Description
cell_rf_metrics	`cell_rf_metrics`	True
cell_throughput_metrics	`cell_throughput_metrics`	True
device_serial_number	string		Serial number of the device installed at the location
id	bigint		Unique identifier for the location
installed_at	timestamp		Date and time the device was installed at the location
name	string		Location Name
pixel_x	integer		X coordinate of the location on the sub-site floorplan
pixel_y	integer		Y coordinate of the location on the sub-site floorplan
site	`sites`		A `sites` entry
site_id	bigint		Unique identifier for the site this location is inside
sub_site	`sub_sites`		A `sub_sites` entry
sub_site_id	bigint		Unique identifier for the sub-site this location is inside

Cellular RF Metrics

Cellular Throughput Metrics

Events

Event Types

Device Startup

Event Type

Event

Sim Object

Device Restart

Event Type

Event

Reason Values

Sites

Sub-Sites

Locations

Further Reading