CheckFox dashboard data export

How can you export data from the CheckFox dashboard?

General export file overview

Export file is available in JSON or XML file format. Structure of the file is the same for both file types. JSON is the prefered file type to work with, XML is just a conversion of it.

For a list of measurements, CSV export is also available (with a limited data set). 

Each export file is divided into few basic keys:

KEY NAME KEY DESCRIPTION ALWAYS IN THE EXPORT
meta Meta information about exported data. ✔️
measurement Single measurement data object. ❌ Only when exporting a single measurement.
measurements Array of multiple measurement objects. Each is the same as the single data object above. ❌Only when exporting multiple measurements or batch measurement detail.
measurements_batch Single object with summary data for batch measurement (multiple sequential measurements). ❌Only in the batch measurement detail.

 

Please note that the CSV export has a limited data set. You will find column name on the first line. Column names are the same as in the JSON/XML files. CSV has no structure so all values need to be in one row in separated columns. We are inlining the station object at the end. That’s why column count will vary for each line/measurement. You will find column “station (x)”, “rssi (x)”, etc. on each line, where the “x” represents the iteration of each station object.

Full description of the objects in the export file.

The meta object

KEY NAME KEY DESCRIPTION FORMAT
dashboard_version Dashboard version that created the export file. string
export_help Link to the export file format documentation (this file). url
exported_from Link to the dashboard that created the export file. url
exported_at Date and time when the export file was created. datetime
fileformat Format of the export file (json/xml/csv) string
export_type*
  • single_measurement
  • single_batch_measurement
  • multiple_measurements
string

*Export types:

  • single_measurement
    Single measurement export, data will be available under the “measurement” key.
  • single_batch_measurement

    Single batch measurement export, data will be under the “measurements” key in form of ARRAY or other “measurement” objects. Also “measurements_batch” key will be created with batch specific values.

  • multiple_measurements
    Multiple measurements, data will be under the “measurements” key in form of ARRAY of more “measurement” objects.

The single_measurement object

KEY NAME KEY DESCRIPTION FORMAT
device Device ID in the Sigfox backend. string
device_name Device name in CheckFox dashboard. string
measurement_id Unique internal measurement ID. string
tapcnt Number of TAPs. int
rep Number of repetitions. int
stations Data from each base station. object
seq Message sequence number. int
payload Uplink message payload. Payload description available here. string (hex)
expmore If true, data is not complete and more data has to be processed. Dashboard is waiting for data from Sigfox. bool
exphwlog If true, data is not complete and more data has to be processed. Dashboard is waiting for device LOG. bool
date Date and time of the message. datetime
avgRssi Second best RSSI from all base stations. float
avgSnr Second best SNR from all base stations. float
bestSNR Best SNR from all base stations. float
2ndBestSNR Second best SNR from all base stations. float
bestRSSI Best RSSI from all base stations. float
2ndBestRSSI Second best RSSI from all base stations. float
coverageIsOk If true, measured coverage is better than predicted. bool
coverageShift

Shift of predicted value to compensate for specific type of measurement. Values: 0 dB (Ref measurement),  -5dB (Ground), -20 dB (Indoor), -30dB (Deep indoor).

int
coverageDeltas Object contains predicted (simulated), measured (real) and delta values from coverage test. object
locationCovered If true, location of measurement is covered. bool
lat Sigfox Atlas approx. location - latitude. float
lng Sigfox Atlas approx. location - longitude. float
radius Sigfox Atlas approx. location - error radius. int
gps_lat GPS real device location - latitude. float
gps_lng GPS real device location - longitude. float
gps_radius GPS real device location - error radius. int
gps_fix GPS fix - if false, last known GPS location is used. bool
gps_speed Device speed from GPS sensor. int
gps_direction Device movement direction in degrees (0-360°). int
gps_alt GPS real device location - altitude. int
gsm_quality GSM signal quality (1-5). int
accel Values from the accelerometer. object
msgts Date and time of the message. unix timestamp

The stations sub-object

KEY NAME KEY DESCRIPTIONS FORMAT
device Device ID in the Sigfox backend. string
station Base station ID. string
rssi RSSI. float
snr SNR. float
rep Number of repetitions. int
freq Base station frequency. float
delay Delay. float
seqNumber Message sequence number. int
time Date and time of the message. datetime
lat Base station location - latitude. float
lng Base station location - longitude. float
station_name Base station name. string
rssiQuality RSSI quality state. string
rssiQualityIcon RSSI quality state icon file. url
snrQuality SNR quality state. string
snrQualityIcon SNR quality state icon file. url

The accel sub-object

KEY NAME KEY DESCRIPTION FORMAT
min Minimal values fetched during measurement. object
max Maximal values fetched during measurement. object

The min and max sub-objects of accel:

KEY NAME KEY DESCRIPTION FORMAT
x Accelerometer reading of axis X (+/-2 g). float
y Accelerometer reading of axis Y (+/-2 g). float
z Accelerometer reading of axis Z (+/-2 g). float

The measurements_batch object

KEY NAME KEY DESCRIPTION FORMAT
messages Number of messages in the measurement. int
stationsUniqueCount Number of unique base station. int
stationsDistanceMax Maximal distance from a base station. int
stationsDistanceMin Minimal distance from a base station. int
stationsMin Minimal number of base stations. int
stationsMax Maximal number of base stations. int
stationsAvg Average number of base stations. int
repsMin Minimal number of repetitions. int
repsMax Maximal number of repetitions. int
repsAvg Average number of repetitions. int
snrMin Minimal SNR. float
snrMax Maximal SNR. float
snrAvg Average SNR. float
rssiMin Minimal RSSI. int
rssiMax Maximal RSSI. int
rssiAvg Average RSSI. int

Export file formats based on export data types

single_measurement
KEY NAME KEY DESCRIPTION FORMAT
meta Meta object type. object
measurement Single measurement of the measurement type. object
single_batch_measurement
KEY NAME KEY DESCRIPTION FORMAT
meta Meta object type. object
measurements_batch Measurements_batch object type. object
measurements Array of measurements, each child the measurement type. array of objects
multiple_measurements
KEY NAME KEY DESCRIPTION FORMAT
meta Meta object type. object
measurements Array of measurements, each child the measurement type. array of objects