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 prefered file type to work with, XML is just a conversion of it.

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

 

Each export file is divided into few basic keys:

 

KEY NAME

KEY DESCRIPTION

ALWAYS THERE

meta

You will find all the meta informations about the export in the file

YES

measurement

Single measurement data object.

NO - only when downloading single measurement

measurements

Array of multiple measurement objects. Each object in the array is the same as the single measurement object above.

NO - only when downloading multiple measurements or batch measurement detail

measurements_batch

Single object containing summary data for batch measurement (more sequential measurements)

NO - only in the batch measurement detail

 

Please note, that CSV export is “special” and have limited data set. You will find column name on the first line. Column name are the same as in the JSON / XML files. CSV is structure-less so all values needs to be on one line in separated columns. So we are doing inlining of the “stations” object at the end. That’s why column count will vary for each line (measurement). So you will find column “station (x)”, “rssi (x)”, … on each line, where “x” is represents iteration of station object.

Full description of the objects in the export file.

“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

What kind of export is this file, possible values:

  • single_measurement
  • single_batch_measurement
  • multiple_measurements

string

 

Export types

 

EXPORT TYPE

DESCRIPTION

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 more “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.



“single_measurement” object

 

KEY NAME

KEY DESCRIPTION

FORMAT

res

string

device

Device ID in Sigfox network

string

device_name

Name of the device in dashboard

string

measurement_id

Internal measurement ID - created from the device id, sequence number and timestamp (unique)

string

tapcnt

Number of TAPs

int

rep

Repetitions count

int

stations

Details from each base station.

object

seq

Message sequence number

int

payload

Payload sent from device. You can find payload description in this document: https://docs.google.com/document/d/1AAf_cUXAkaDMDyjCvue1F8s-z6W_2q_G7B_SB-5XYKw/view

string (hex)

expmore

Internal flag - if true, data are not complete and you should wait for more data to be processed.

Dashboard is waiting for more data from sigfox network.

bool

exphwlog

Internal flag - if true, data are not completed and you should wait for more data to be processed.

Dashboard is waiting for LOG from device.

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 BTS

float

2ndBestSNR

2nd best SNR from all BTS

float

bestRSSI

Best RSSI from all BTS

float

2ndBestRSSI

2nd best RSSI from all BTS

float

coverageIsOk

Is measured coverage better or worse than predicted coverage?

bool

coverageShift

Shift of predicted value to compensate for specific type of measurement.

0 for Ref measurement,  5dB for Ground, -20 dB for indoor, -30dB for deep indoor

int

coverageDeltas

Object contains predicted (simulated), measured (real) and delta values from coverage test 

object

locationCovered

Should the location of measurement be covered?

bool

lat

Approximate location (Atlas) - Latitude

float

lng

Approximate location (Atlas) - Longitude

float

radius

Approximate location - Error radius

int

gps_lat

Real device GPS location - Latitude

float

gps_lng

Real device GPS location - Longitude

float

gps_radius

Real device GPS location - Error radius

int

gps_fix

Real device GPS fix - true/false (when false, last known GPS location of device is used)

bool

gps_speed

Device speed from GPS sensor

int

gps_direction

Device movement direction in degrees (0-360)

int

gps_alt

Device altitude from GPS sensor

int

gsm_quality

GSM signal quality (1-5)

int

accel

Readings from device accelerometer

object

msgts

Date and time of the message

unix timestamp

 

“stations” sub-object

 

KEY NAME

KEY DESCRIPTION

FORMAT

device

Device ID in Sigfox network

string

station

Station ID

string

rssi

RSSI

float

snr

SNR

float

rep

Repetitions

int

freq

Base station frequency

float

delay

float

seqNumber

Sequence number of the message

int

time

Date and time of the message

datetime

lat

Location of the base station - Latitude

float 

lng

Location of the base station - 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

 

“accel” sub-object

 

KEY NAME

KEY DESCRIPTION

FORMAT

min

Minimal values fetched during measurement

object

max

Maximal values fetched during measurement

object

 

“min” and “max” sub-object (of accel)

 

KEY NAME

KEY DESCRIPTION

FORMAT

x

Accelerometer reading of axis X (-2 - +2)

float

y

Accelerometer reading of axis Y (-2 - +2)

float

z

Accelerometer reading of axis Z (-2 - +2)

float



“measurements_batch” object

 

KEY NAME

KEY DESCRIPTION

FORMAT

messages

Number of messages in the measurement

int

stationsUniqueCount

int

stationsDistanceMax

int

stationsDistanceMin

int

stationsMin

int

stationsMax

int

stationsAvg

int

repsMin

int

repsMax

int

repsAvg

int

snrMin

float

snrMax

float

snrAvg

float

rssiMin

int

rssiMax

int

rssiAvg

int

Export file formats based on export data types

single_measurement

{

  • “meta”: object - meta object type
  • “measurement” - object - single measurement of type “measurement”

}

 

single_batch_measurement

{

  • “meta”: object - meta object type
  • “measurements_batch”: object - measurements_batch object type
  • “measurements” - array of objects - array of measurements, each child is of type “measurement”

}

 

multiple_measurements

{

  • “meta”: object - meta object type
  • “measurements” - array of objects - array of measurements, each child is of type “measurement”

}