Dataset: Device Log
Dataset name:
ds_device_log
Description
Device Log data.
Fields in this dataset
Name | Field Name | Description | Field Type | Field Example |
---|---|---|---|---|
Action |
action
|
Action | varchar | 45 |
Created Timestamp |
created_timestamp
|
Timestamp of when the record was created. | int | 1642137111 |
End Timestamp |
end_time
|
End Timestamp | int | 1642137111 |
Event ID |
event_id
|
Event ID | int | 45 |
External ID |
external_id
|
External ID. | int | 1 |
ID |
id
|
The primary identifier for this record. | serial | |
Instance |
instance
|
The instance this item relates to. | int | |
Log Time |
log_time
|
Log Time. | int | 1642137111 |
Sensor Type ID |
sensor_type_id
|
The type of the sensor (for devices with multiple sensors) | int | 123 |
Sensor Value |
sensor_value
|
The value of the sensor | int | 123 |
Source |
source
|
The source of the data - user or connection. | varchar | |
Start Timestamp |
start_time
|
Start Timestamp | int | 123 |
Making an API request for this Dataset
Example Request to the Sandbox Server
http://sbx-api.mydex.org/api/pds/transaction/UID.json ?key=KEY &api_key=API_KEY &con_id=CON_ID &source_type=connection &dataset=ds_device_log &instance=N
Replace the following with your own details: UID
KEY
, API_KEY
, CON_ID
and instance N
.
Replace sbx-api
with api
when making a connection to a real member on the production server (must be authenticated).
To return the data in XML, change UID.json
to UID.xml
.
Example Response
A response to this API request will be structured as follows.
{ "": { "id": null, "ds_id": null, "action": "45", "created_timestamp": "1642137111", "end_time": "1642137111", "event_id": "45", "external_id": "1", "log_time": "1642137111", "sensor_type_id": "123", "sensor_value": "123", "start_time": "123" } }