Jetstream API
...
API Endpoints
Event Configuration
Get Events
9min
about return, but do not dequeue, the oldest pending event messages for the jetstream user whose access key is being used by default, no more than 100 messages will be returned on any given get events request users must subscribe to get events by making an initial get events request with the applicable user access key this initial subscription request will not return any events, as events are not queued until the subscription is created users will be automatically unsubscribed after 30 days of not making a get events request more info each get events request returns a batch of event messages along with an associated batch id by using this batch id with a delete events docid 1z8wlwmzoguy dpo9sqgk request, all events within this batch can be removed parameters property location details accesskey string required unique header the access key for your user account this value is a 36 character guid provided during user account sign up https //jetstreamrfid com/login/signup limit int url the number of messages to return this value is a number within the following range 1 512 this property is optional and does not need to be defined in all requests if it is not defined, the value defaults to 100 type string searchable url the event type device string searchable url the name of the device example request url get https //api jetstreamrfid com/2/events/5 request body none required response code 200 ok response body { "batchid" "c15d316b 5fc3 4a7f a2ba b1a96aabcd32", "count" 5, "events" \[ { "commandid" "2bf00848 b06a 4820 86fc 58c12e08ee3e", "commandname" "setconfigvaluescommand", "outputparameterlist" \[], "exceptionlist" \[], "device" "mydevicename1", "receivedtime" "2017 05 19t01 16 23z", "type" "commandcompletionevent", "eventid" "93723c89 cb44 44f0 8d86 87ede0fb3ba6", "eventtime" "2017 05 19t01 16 19z" }, { "device" "mydevicename1", "commandid" "2bf00848 b06a 4820 86fc 58c12e08ee3e", "commandname" "setconfigvaluescommand", "uri" "/2/devices/mydevicename1/policy/sync", "verb" "post", "user" "myusername", "parameters" \[ { "key" "aggregateeventscancount", "value" "4" } ], "type" "commandqueuedevent", "eventid" "f3df515b c53a 4b3b b3e9 01ffe6ffd8f3", "eventtime" "2017 05 19t01 16 21z" }, { "device" "mydevicename2", "receivedtime" "2017 05 19t01 19 44z", "type" "heartbeatevent", "eventid" "b55cf245 4a17 438e 8b12 538c3ef6f536", "eventtime" "2017 05 19t01 19 43z" }, { "device" "mydevicename1", "receivedtime" "2017 05 19t02 05 40z", "type" "heartbeatevent", "eventid" "9e5d2294 655e 4a11 ba02 e504b435e75f", "eventtime" "2017 05 19t02 05 36z" }, { "sensorreadings" \[ { "name" "temperaturea", "value" " 16", "readingtime" "2017 05 19t02 06 25z" }, { "name" "temperatureb", "value" " 61", "readingtime" "2017 05 19t02 06 25z" } ], "device" "mydevicename1", "receivedtime" "2017 05 19t02 06 28z", "type" "sensorreadingevent", "eventid" "66524199 0c71 40d2 a36a c05983b70355", "eventtime" "2017 05 19t02 06 25z" } ] } version changes replaces getevents example request url get https //api jetstreamrfid com/2/events/5 request body none required response code 200 ok response body { "batchid" "c15d316b 5fc3 4a7f a2ba b1a96aabcd32", "count" 5, "events" \[ { "commandid" "2bf00848 b06a 4820 86fc 58c12e08ee3e", "commandname" "setconfigvaluescommand", "outputparameterlist" \[], "exceptionlist" \[], "device" "mydevicename1", "receivedtime" "2017 05 19t01 16 23z", "type" "commandcompletionevent", "eventid" "93723c89 cb44 44f0 8d86 87ede0fb3ba6", "eventtime" "2017 05 19t01 16 19z" }, { "device" "mydevicename1", "commandid" "2bf00848 b06a 4820 86fc 58c12e08ee3e", "commandname" "setconfigvaluescommand", "uri" "/2/devices/mydevicename1/policy/sync", "verb" "post", "user" "myusername", "parameters" \[ { "key" "aggregateeventscancount", "value" "4" } ], "type" "commandqueuedevent", "eventid" "f3df515b c53a 4b3b b3e9 01ffe6ffd8f3", "eventtime" "2017 05 19t01 16 21z" }, { "device" "mydevicename2", "receivedtime" "2017 05 19t01 19 44z", "type" "heartbeatevent", "eventid" "b55cf245 4a17 438e 8b12 538c3ef6f536", "eventtime" "2017 05 19t01 19 43z" }, { "device" "mydevicename1", "receivedtime" "2017 05 19t02 05 40z", "type" "heartbeatevent", "eventid" "9e5d2294 655e 4a11 ba02 e504b435e75f", "eventtime" "2017 05 19t02 05 36z" }, { "sensorreadings" \[ { "name" "temperaturea", "value" " 16", "readingtime" "2017 05 19t02 06 25z" }, { "name" "temperatureb", "value" " 61", "readingtime" "2017 05 19t02 06 25z" } ], "device" "mydevicename1", "receivedtime" "2017 05 19t02 06 28z", "type" "sensorreadingevent", "eventid" "66524199 0c71 40d2 a36a c05983b70355", "eventtime" "2017 05 19t02 06 25z" } ] } version changes replaces getevents