Skip to main content

Sensor Report

Sensor report collection stores comprehensive sensor measurement data from IoT devices, including environmental conditions, quality metrics, and device readings linked to specific EPCIS events for enhanced supply chain monitoring.

The sensor_report Object

Sensor report collection contains detailed measurement data from various sensors and IoT devices, supporting quality monitoring, environmental tracking, and compliance requirements throughout the supply chain. Each row in this table represents a measurement in an EPCIS event. Note that an EPCIS event could have many sensor report objects within.

Field NameTypeDescription
idstringPrimary key. Unique identifier for the sensor report (UUID format).
event_idstringReference to the associated EPCIS event. Foreign key to epc_events.event_id.
report_timedatetimeTimestamp when the sensor report was generated.
start_timedatetimeStart time of the measurement period.
end_timedatetimeEnd time of the measurement period.
device_id_rawstringRaw device identifier as reported by the sensor.
device_id_join_keystringNormalized device identifier for joining with other tables.
device_metadatastringMetadata about the sensor device (model, firmware version, etc.).
raw_datastringRaw sensor data as received from the device.
data_processing_methodstringDescription of how the raw data was processed.
biz_rulesstringBusiness rules applied to the sensor data.
sensor_report_typestringType of sensor measurement (e.g., "rail:axialClearance", "temperature").
sensor_report_exceptionstringException or alert conditions detected in the sensor data.
microorganismstringMicroorganism detection results (for biological sensors).
chemical_substancestringChemical substance detection results (for chemical sensors).
valuenumberPrimary measurement value from the sensor.
componentstringSpecific component or part being measured.
string_valuestringString-based measurement value (for non-numeric data).
boolean_valuebooleanBoolean measurement value (for true/false sensors).
hex_binary_valuestringBinary measurement data in hexadecimal format.
uri_valuestringURI-based measurement value or reference.
min_valuenumberMinimum value recorded during the measurement period.
max_valuenumberMaximum value recorded during the measurement period.
mean_valuenumberMean/average value recorded during the measurement period.
s_devnumberStandard deviation of measurements during the period.
perc_ranknumberPercentile rank of the measurement.
perc_valuenumberPercentile value of the measurement.
uomstringUnit of measurement (e.g., "MMT", "°C", "kg").
coordinate_reference_systemstringCoordinate reference system for spatial measurements.

List Sensor Reports

List existing sensor reports.

GET /items/sensor_report

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit sensor report objects. If no items are available, data will be an empty array.


Retrieve a Sensor Report

Retrieve a specific sensor report by ID.

GET /items/sensor_report/:id

Returns

Returns a sensor report object if a valid primary key was provided.


Sample Data

Example Sensor Report Response

{
"data": {
"id": "09b623af-4cd2-11f0-bf42-1e14173c8de9",
"event_id": "ni:///sha-256;005d98cd0f3cb306f0c283e4667cbbc878006095827126e6d3036a35ba59e032?ver=CBV2.0",
"report_time": "2025-02-19T12:20:00.000Z",
"start_time": null,
"end_time": null,
"device_id_raw": "https://api.reelables.com/v1/assets/jx3r9JQBe7SquDs7erDO",
"device_id_join_key": "https://api.reelables.com/v1/assets/jx3r9JQBe7SquDs7erDO",
"device_metadata": null,
"raw_data": null,
"data_processing_method": null,
"biz_rules": null,
"sensor_report_type": "Temperature",
"sensor_report_exception": null,
"microorganism": null,
"chemical_substance": null,
"value": "23.00000",
"component": null,
"string_value": null,
"boolean_value": null,
"hex_binary_value": null,
"uri_value": null,
"min_value": null,
"max_value": null,
"mean_value": null,
"s_dev": null,
"perc_rank": null,
"perc_value": null,
"uom": "CEL",
"coordinate_reference_system": null
}
}