{"_id":"557f7f3a38249b0d00d0d176","project":"557f5c2aeb75d80d00af40db","githubsync":"","user":"557f5be9eb75d80d00af40d9","category":{"_id":"557f736366ed730d00c8a38c","project":"557f5c2aeb75d80d00af40db","__v":9,"pages":["557f74ff66ed730d00c8a397","557f76ac38249b0d00d0d15b","557f7f0966ed730d00c8a3a0","557f7f3a38249b0d00d0d176","557f7f7566ed730d00c8a3a2","557f7f83e4f3070d0068aa24","557f7f8ee4f3070d0068aa25","557f7f9c38249b0d00d0d179","55bab9c61b0d663700781621"],"version":"557f736266ed730d00c8a388","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-16T00:11:28.806Z","from_sync":false,"order":3,"slug":"event-api","title":"Event API"},"editedParams2":true,"__v":0,"editedParams":true,"version":{"_id":"557f736266ed730d00c8a388","project":"557f5c2aeb75d80d00af40db","__v":1,"forked_from":"557f5c2aeb75d80d00af40de","createdAt":"2015-06-16T00:52:50.718Z","releaseDate":"2015-06-16T00:52:50.718Z","categories":["557f736366ed730d00c8a389","557f736366ed730d00c8a38a","557f736366ed730d00c8a38b","557f736366ed730d00c8a38c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.19","version":"2.0.19"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-16T01:43:22.200Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":" curl 'https://api.clearpathgps.com:8443/events/Data.json?user=me:::at:::myco.com&password=secret&group=all&limit=5'","name":""}]},"method":"get","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n   \"Account\": \"clearpathgps\",\n   \"Account_desc\": \"ClearPathGPS\",\n   \"TimeZone\": \"US/Pacific\",\n   \"DeviceList\": [\n      {\n         \"Device\": \"4542088719\",\n         \"Device_desc\": \"Steve\",\n         \"EventData\": [\n            {\n               \"Device\": \"4542088719\",\n               \"Timestamp\": 1434413844,\n               \"Timestamp_date\": \"2015/06/15\",\n               \"Timestamp_time\": \"17:17:24\",\n               \"StatusCode\": 61472,\n               \"StatusCode_hex\": \"0xF020\",\n               \"StatusCode_desc\": \"Moving\",\n               \"GPSPoint\": \"34.5918768,-120.0346171\",\n               \"GPSPoint_lat\": 34.5918768,\n               \"GPSPoint_lon\": -120.0346171,\n               \"Speed_kph\": 90.0,\n               \"Speed\": 55.9,\n               \"Speed_units\": \"mph\",\n               \"Heading\": 137.0,\n               \"Heading_desc\": \"SE\",\n               \"Odometer_km\": 4713.741,\n               \"Odometer\": 2928.983,\n               \"Odometer_units\": \"Miles\",\n               \"Address\": \"San Marcos Pass Road, Santa Ynez, CA 93460, USA\",\n               \"Index\": 0\n            },\n            {\n               \"Device\": \"4542088719\",\n               \"Timestamp\": 1434413875,\n               \"Timestamp_date\": \"2015/06/15\",\n               \"Timestamp_time\": \"17:17:55\",\n               \"StatusCode\": 61472,\n               \"StatusCode_hex\": \"0xF020\",\n               \"StatusCode_desc\": \"Moving\",\n               \"GPSPoint\": \"34.5881590,-120.0284036\",\n               \"GPSPoint_lat\": 34.5881590,\n               \"GPSPoint_lon\": -120.0284036,\n               \"Speed_kph\": 88.0,\n               \"Speed\": 54.7,\n               \"Speed_units\": \"mph\",\n               \"Heading\": 107.0,\n               \"Heading_desc\": \"E\",\n               \"Odometer_km\": 4714.444,\n               \"Odometer\": 2929.420,\n               \"Odometer_units\": \"Miles\",\n               \"Address\": \"203-227 San Marcos Pass Road, Santa Ynez, CA 93460, USA\",\n               \"Index\": 1\n            }\n         ]\n      },\n      {\n         \"Device\": \"4731009570\",\n         \"Device_desc\": \"Scott\",\n         \"EventData\": [\n            {\n               \"Device\": \"4731009570\",\n               \"Timestamp\": 1434413815,\n               \"Timestamp_date\": \"2015/06/15\",\n               \"Timestamp_time\": \"17:16:55\",\n               \"StatusCode\": 61472,\n               \"StatusCode_hex\": \"0xF020\",\n               \"StatusCode_desc\": \"Moving\",\n               \"GPSPoint\": \"34.4281925,-119.6924521\",\n               \"GPSPoint_lat\": 34.4281925,\n               \"GPSPoint_lon\": -119.6924521,\n               \"Speed_kph\": 11.0,\n               \"Speed\": 6.8,\n               \"Speed_units\": \"mph\",\n               \"Heading\": 276.0,\n               \"Heading_desc\": \"W\",\n               \"Odometer_km\": 105227.804,\n               \"Odometer\": 65385.526,\n               \"Odometer_units\": \"Miles\",\n               \"Address\": \"701-799 East Canon Perdido Street, Santa Barbara, CA 93103, USA\",\n               \"Index\": 0\n            },\n            {\n               \"Device\": \"4731009570\",\n               \"Timestamp\": 1434413835,\n               \"Timestamp_date\": \"2015/06/15\",\n               \"Timestamp_time\": \"17:17:15\",\n               \"StatusCode\": 62467,\n               \"StatusCode_hex\": \"0xF403\",\n               \"StatusCode_desc\": \"Ignition_Off\",\n               \"GPSPoint\": \"34.4281380,-119.6925163\",\n               \"GPSPoint_lat\": 34.4281380,\n               \"GPSPoint_lon\": -119.6925163,\n               \"Speed_kph\": 0.0,\n               \"Speed\": 0.0,\n               \"Speed_units\": \"mph\",\n               \"Odometer_km\": 105227.812,\n               \"Odometer\": 65385.531,\n               \"Odometer_units\": \"Miles\",\n               \"Address\": \"701-799 East Canon Perdido Street, Santa Barbara, CA 93103, USA\",\n               \"Index\": 1\n            }\n         ]\n      }\n   ]\n}\n"}]},"settings":"557f75ba38249b0d00d0d152","auth":"required","params":[{"_id":"557f76ac38249b0d00d0d15c","ref":"","in":"query","required":false,"desc":"The user name","default":"","type":"string","name":"user"},{"_id":"557f79f238249b0d00d0d164","ref":"","in":"query","required":false,"desc":"The password","default":"","type":"string","name":"password"},{"_id":"557f79f238249b0d00d0d163","ref":"","in":"query","required":false,"desc":"The device ID (Optional)","default":"","type":"string","name":"device"},{"_id":"557f79f238249b0d00d0d162","ref":"","in":"query","required":false,"desc":"The group ID (Optional)","default":"","type":"string","name":"group"},{"_id":"557f79f238249b0d00d0d161","ref":"","in":"query","required":false,"desc":"Time From - UTC in epoch format (Optional)","default":"","type":"timestamp","name":"rf"},{"_id":"557f79f238249b0d00d0d160","ref":"","in":"query","required":false,"desc":"Time To - UTC in epoch format (Optional)","default":"","type":"timestamp","name":"rt"},{"_id":"557f79f238249b0d00d0d15f","ref":"","in":"query","required":false,"desc":"Limit number of returned events (Optional)","default":"","type":"int","name":"limit"},{"_id":"557f79f238249b0d00d0d15e","ref":"","in":"query","required":false,"desc":"Display Additional Fields (Optional)","default":"","type":"boolean","name":"allTags"}],"url":"/Data.json"},"isReference":false,"order":2,"body":"","excerpt":"","slug":"retrieve-events-json-format","type":"endpoint","title":"Retrieve Events - JSON Format"}

getRetrieve Events - JSON Format


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

user:
string
The user name
password:
string
The password
device:
string
The device ID (Optional)
group:
string
The group ID (Optional)
rf:
timestamp
Time From - UTC in epoch format (Optional)
rt:
timestamp
Time To - UTC in epoch format (Optional)
limit:
integer
Limit number of returned events (Optional)
allTags:
boolean
Display Additional Fields (Optional)

Examples


Result Format