Retrieving Signal Data
Retrieving Signal Data is done through the SignalAnalysis resource. The SignalAnalysis resource is generated as a result of processing a SnapshotAnalysis input.
SignalAnalysis
A SignalAnalysis resource contains information about the processed Signal data. Including the SignalExpressions that were synthesized as a part of the SnapshotAnalysis process.
"signalAnalysis": {
"id": "69b94ec956c5c00171d7d353",
"name": "Customer Demo",
"ownerId": "9766b1e3-7669-4b8b-a331-638b3cddc843",
"processingState": {
"errorMessage": "N/A",
"status": "done"
},
"publicFlag": false,
"signalExpressions": {
"expressions": [
{
"expression": "c125700",
"key": "c125700",
"name": "direct_c125700_reference"
},
{
"expression": "c125700 * 1",
"key": "s3",
"name": "in_use_ds02_b1_ratio_synthetic"
},
{
"expression": "c125698",
"key": "c125698",
"name": ""
},
{
"expression": "c1251",
"key": "c1251",
"name": ""
},
{
"expression": "c1251 * 1000",
"key": "s1",
"name": "custom_synthetic_c1251*1000"
},
{
"expression": "c125698 * s1",
"key": "s2",
"name": "in_use_egr_vvt_ratio_synthetic*s1"
}
]
}
},
Signal Data
The SignalAnalysis resource encapsulates the processed Signal Data as a result of processing the SnapshotAnalysis. After clients obtain a reference to the SignalAnalysis resource. Clients can retrieve the processed Signal Data encoded in different formats.
JSON encoded Signal Data
Clients can retrieve the Signal Data in a JSON encoded format using GET /signalanalysis/:id/data.
{
"signalAnalysis": {
"id": "69b94ec956c5c00171d7d353",
"name": "Customer Demo",
"ownerId": "9766b1e3-7669-4b8b-a331-638b3cddc843",
"processingState": {
"errorMessage": "N/A",
"status": "done"
},
"publicFlag": false,
"signalExpressions": {
"expressions": [
{
"expression": "c125700",
"key": "c125700",
"name": "direct_c125700_reference"
},
{
"expression": "c125700 * 1",
"key": "s3",
"name": "in_use_ds02_b1_ratio_synthetic"
},
{
"expression": "c125698",
"key": "c125698",
"name": ""
},
{
"expression": "c1251",
"key": "c1251",
"name": ""
},
{
"expression": "c1251 * 1000",
"key": "s1",
"name": "custom_synthetic_c1251*1000"
},
{
"expression": "c125698 * s1",
"key": "s2",
"name": "in_use_egr_vvt_ratio_synthetic*s1"
}
]
}
},
"data": [
{
"epochMs": 1507908108188,
"idFile": 891317,
"idPackage": 13,
"idVin": 22,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 19132,
"key": "c1251",
"stringValue": ""
},
"c125698": {
"dataType": "f",
"doubleValue": 0.6069160197600565,
"key": "c125698",
"stringValue": ""
},
"c125700": {
"dataType": "f",
"doubleValue": 0.9188608275120903,
"key": "c125700",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 19132000,
"key": "s1",
"stringValue": ""
},
"s2": {
"dataType": "f",
"doubleValue": 11611517.2900494,
"key": "s2",
"stringValue": ""
},
"s3": {
"dataType": "f",
"doubleValue": 0.9188608275120903,
"key": "s3",
"stringValue": ""
}
}
},
{
"epochMs": 1507843247377,
"idFile": 891294,
"idPackage": 13,
"idVin": 22,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 19031,
"key": "c1251",
"stringValue": ""
},
"c125698": {
"dataType": "f",
"doubleValue": 0.606852702225362,
"key": "c125698",
"stringValue": ""
},
"c125700": {
"dataType": "f",
"doubleValue": 0.9187735341581496,
"key": "c125700",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 19031000,
"key": "s1",
"stringValue": ""
},
"s2": {
"dataType": "f",
"doubleValue": 11549013.776050866,
"key": "s2",
"stringValue": ""
},
"s3": {
"dataType": "f",
"doubleValue": 0.9187735341581496,
"key": "s3",
"stringValue": ""
}
}
},
{
"epochMs": 1507897935573,
"idFile": 891287,
"idPackage": 13,
"idVin": 22,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 19057,
"key": "c1251",
"stringValue": ""
},
"c125698": {
"dataType": "f",
"doubleValue": 0.6065631616090331,
"key": "c125698",
"stringValue": ""
},
"c125700": {
"dataType": "f",
"doubleValue": 0.9193114577729963,
"key": "c125700",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 19057000,
"key": "s1",
"stringValue": ""
},
"s2": {
"dataType": "f",
"doubleValue": 11559274.170783345,
"key": "s2",
"stringValue": ""
},
"s3": {
"dataType": "f",
"doubleValue": 0.9193114577729963,
"key": "s3",
"stringValue": ""
}
}
},
{
"epochMs": 1447976873000,
"idFile": 455618,
"idPackage": 84,
"idVin": 311,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 65535,
"key": "c1251",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 65535000,
"key": "s1",
"stringValue": ""
}
}
},
{
"epochMs": 1447674092000,
"idFile": 452696,
"idPackage": 84,
"idVin": 311,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 65535,
"key": "c1251",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 65535000,
"key": "s1",
"stringValue": ""
}
}
},
{
"epochMs": 1448017470000,
"idFile": 455677,
"idPackage": 84,
"idVin": 311,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 65535,
"key": "c1251",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 65535000,
"key": "s1",
"stringValue": ""
}
}
},
{
"epochMs": 1447699353000,
"idFile": 453111,
"idPackage": 84,
"idVin": 311,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 65535,
"key": "c1251",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 65535000,
"key": "s1",
"stringValue": ""
}
}
},
{
"epochMs": 1448019774000,
"idFile": 455687,
"idPackage": 84,
"idVin": 311,
"signalValues": {
"c1251": {
"dataType": "f",
"doubleValue": 65535,
"key": "c1251",
"stringValue": ""
},
"s1": {
"dataType": "f",
"doubleValue": 65535000,
"key": "s1",
"stringValue": ""
}
}
},
...
],
"vehicleMetadata": {
"1575": {
"idConfig": 12583,
"idVin": 1575,
"vehNo": "BM109181"
},
"311": {
"idConfig": 12092,
"idVin": 311,
"vehNo": "AW156539"
},
"3711": {
"idConfig": 15504,
"idVin": 3711,
"vehNo": "DFA55929"
},
"1755": {
"idConfig": 15440,
"idVin": 1755,
"vehNo": "ibf8"
},
"1696": {
"idConfig": 15343,
"idVin": 1696,
"vehNo": "ITV123HX6"
},
"1828": {
"idConfig": 15034,
"idVin": 1828,
"vehNo": "H9803596"
},
"1588": {
"idConfig": 14738,
"idVin": 1588,
"vehNo": "GG341598"
},
"22": {
"idConfig": 12711,
"idVin": 22,
"vehNo": "AF100816"
},
"1613": {
"idConfig": 12314,
"idVin": 1613,
"vehNo": "GPS-1"
},
"3693": {
"idConfig": 15085,
"idVin": 3693,
"vehNo": "FH516945"
},
"677": {
"idConfig": 13517,
"idVin": 677,
"vehNo": "GC37102"
},
"1659": {
"idConfig": 13309,
"idVin": 1659,
"vehNo": "HL210056"
},
"1657": {
"idConfig": 12058,
"idVin": 1657,
"vehNo": "H7100265"
}
},
"error": "EOF"
}
The response contains the SignalAnalysis model and an array of data points corresponding to the SignalExpressions defined in the SignalAnalysis. Each data point contains a timestamp (epochMs), signal values for each SignalExpression, and metadata about the vehicle and file from which the data was sourced.
CSV encoded Signal data
The Signal Data from a SignalAnalysis resource can be processed into a CSV. The SignalAnalysisExport resource encapsulates the process of exporting the SignalAnalysis data into a CSV format. Clients can create a SignalAnalysisExport resource with a reference to the SignalAnalysis.
POST /signalanalysisexports
Sending the SignalAnalysis.id in the body of the request to POST /signalanalysisexports will create a SignalAnalysisExport resource that will process the Signal Data for the referenced SignalAnalysis resource into a CSV format.
{
"signalAnalysisId": "SignalAnalysis.id" <- the id of the SignalAnalysis resource obtained previously
}
Response
The response will contain information about the created SignalAnalysisExport resource. Including its processing state.
{
"createdAt": "0001-01-01T00:00:00Z",
"id": "69b9543b68c537088b33c02d",
"ownerId": "",
"processingState": {
"errorMessage": "N/A",
"status": "submitted"
},
"signalAnalysisId": "69b94ec956c5c00171d7d353",
"tenantId": 101
}
Monitoring the SignalAnalysisExport processing state
Clients can monitor the processing state of the SignalAnalysisExport resource by polling GET /signalanalysisexports/:id/processingState
Request
GET /signalanalysisexports/:id/processingState
Response
{
"errorMessage": "N/A",
"status": "done"
}
Retreiving the CSV
Once the SignalAnalysisExport resource is done processing, clients can retreive the CSV file containing the Signal Data by calling GET /signalanalysisexports/:id/data using the id of the SignalAnalysisExport resource.