{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/live/location.json","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"vehicleName","type":"string","default":"","desc":"Name of the vehicle","required":false,"in":"query","ref":"","_id":"5631a1b59ead230d00a18987"},{"name":"groupName","type":"string","default":"","desc":"Name of the group","required":false,"in":"query","ref":"","_id":"5631a1b59ead230d00a18986"},{"name":"page","type":"int","default":"1","desc":"Page number of the paginated result","required":false,"in":"query","ref":"","_id":"5631a1b59ead230d00a18985"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"liveMapResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Dec-10-2015, 10:19 AM UTC\",\n      \"currentPage\":1,\n      \"totalPages\":1,\n      \"locations\":[  \n         {  \n            \"vehicleName\":\"Joe's Cooper\",\n            \"vehicleId\": \"b0debf38-ad8d-11e5-b684-616a28550141\",\n            \"date\":\"Dec-10-2015, 05:19 AM UTC\",\n            \"event\":\"GPS Tracking\",\n            \"speed\":\"3 MPH\",\n            \"stopTime\":\"0 mins\",\n            \"idleTime\":\"10 mins\",\n            \"vehicleId\":\"be0e61af-96d5-11e2-9285-ffeed36de12d\",\n            \"groupId\":\"e18b4fcc-96d5-11e2-bb3e-c106257e36f0\",\n            \"groupName\":\"West Coast\",\n            \"phoneNumber\":\"\",\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"latitude\":37.373013,\n            \"longitude\":-121.924457,\n            \"location\":\"Bayshore Freeway, San Jose, CA 95110, USA\"\n         },\n         {  \n            \"vehicleName\":\"Adams SUV\",\n            \"vehicleId\": \"ee02acb8-ac3e-11e4-90dd-e1190100e6eb\",\n            \"date\":\"Dec-10-2015, 10:05 AM UTC\",\n            \"event\":\"Ignition Off\",\n            \"speed\":\"0 MPH\",\n            \"stopTime\":\"35927 mins\",\n            \"idleTime\":\"0 mins\",\n            \"vehicleId\":\"c148cc80-58fd-11e2-804a-19707e3e1e71\",\n            \"groupId\":\"dfa9fdda-2c0e-11e2-b5be-8f69786b759a\",\n            \"groupName\":\"Default Group\",\n            \"phoneNumber\":\"\",\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"latitude\":37.366791,\n            \"longitude\":-121.918167,\n            \"location\":\"1731 Technology Drive, San Jose, CA 95110, USA\"\n         }\n      ]\n   }\n}\n\n","name":""}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"Live Status","type":"endpoint","slug":"live","excerpt":"Use this API to get the real time status of all your vehicles. This data refreshes frequently and the API returns the most recent data.","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Alternative Approach\",\n  \"body\": \"You can subscribe to our webhooks for this event to receive data in real-time. For more information on webhooks and how to get started, please visit our [webhook documentation](https://developer.azuga.com/v3)\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/live/location.json\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"code\",\n    \"1-0\": \"message\",\n    \"2-0\": \"generatedAt\",\n    \"3-0\": \"reason\",\n    \"4-0\": \"currentPage\",\n    \"5-0\": \"totalPages\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-1\": \"The reason for failure\",\n    \"4-1\": \"The current page\",\n    \"5-1\": \"The total number of pages in the result\",\n    \"6-0\": \"locations\",\n    \"7-0\": \"vehicleName\",\n    \"8-0\": \"date\",\n    \"9-0\": \"event\",\n    \"10-0\": \"speed\",\n    \"11-0\": \"vehicleId\",\n    \"12-0\": \"stopTime\",\n    \"14-0\": \"groupId\",\n    \"15-0\": \"groupName\",\n    \"16-0\": \"phoneNumber\",\n    \"17-0\": \"reserved1\",\n    \"18-0\": \"reserved2\",\n    \"19-0\": \"reserved3\",\n    \"20-0\": \"reserved4\",\n    \"6-1\": \"An array of location objects\",\n    \"7-1\": \"Name of the vehicle\",\n    \"9-1\": \"Last activity of the vehicle\",\n    \"10-1\": \"Speed of the vehicle\",\n    \"11-1\": \"Unique identifier representing the vehicle\",\n    \"8-1\": \"Timestamp in UTC when the last activity occured\",\n    \"12-1\": \"Time between the last ignition OFF and the current system time\",\n    \"14-1\": \"Unique identifier of the group associated with the vehicle\",\n    \"15-1\": \"Name of the group associated with the vehicle\",\n    \"16-1\": \"Phone number of the driver\",\n    \"17-1\": \"Reserved variable for future use\",\n    \"18-1\": \"Reserved variable for future use\",\n    \"19-1\": \"Reserved variable for future use\",\n    \"20-1\": \"Reserved variable for future use\",\n    \"21-0\": \"latitude\",\n    \"22-0\": \"longitutde\",\n    \"23-0\": \"location\",\n    \"21-1\": \"Latitude coordinate of the location\",\n    \"22-1\": \"Longitude coordinate of the location\",\n    \"23-1\": \"Address of the location\",\n    \"13-0\": \"idleTime\",\n    \"13-1\": \"Time period during which the vehicle was in the idle state\"\n  },\n  \"cols\": 2,\n  \"rows\": 24\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5592bda06bf22f170075b858","__v":2,"editedParams":true,"parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":["5592bda06bf22f170075b858","5593dbb99755e117000fbf3d","5593dc7a0e82e81700334e23","5631abc1fc94aa0d00e9b5e6","5631b5acbddb091700ad5de2","5631be58fc94aa0d00e9b5f5","56dfa9429cd22c0e00cab10c"],"title":"REPORTS","slug":"fleet-web","order":2,"from_sync":false,"reference":true,"_id":"5592bd7b9a68220d00f1c3db","createdAt":"2015-06-30T16:02:03.540Z","version":"559286c6c39c4b2d00127a71","__v":7,"project":"55926c913735880d005f7c65"},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"editedParams2":true,"githubsync":"","project":"55926c913735880d005f7c65","createdAt":"2015-06-30T16:02:40.017Z","user":"55926c39cf9cdb2100b57022"}

getLive Status

Use this API to get the real time status of all your vehicles. This data refreshes frequently and the API returns the most recent data.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

vehicleName:
string
Name of the vehicle
groupName:
string
Name of the group
page:
integer1
Page number of the paginated result

Result Format


Documentation

[block:callout] { "type": "warning", "title": "Alternative Approach", "body": "You can subscribe to our webhooks for this event to receive data in real-time. For more information on webhooks and how to get started, please visit our [webhook documentation](https://developer.azuga.com/v3)" } [/block] [block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/live/location.json" } [/block] ##API Response explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "1-0": "message", "2-0": "generatedAt", "3-0": "reason", "4-0": "currentPage", "5-0": "totalPages", "0-1": "API Status Code", "1-1": "API Message (Success/Failure)", "2-1": "API generation timestamp in UTC", "3-1": "The reason for failure", "4-1": "The current page", "5-1": "The total number of pages in the result", "6-0": "locations", "7-0": "vehicleName", "8-0": "date", "9-0": "event", "10-0": "speed", "11-0": "vehicleId", "12-0": "stopTime", "14-0": "groupId", "15-0": "groupName", "16-0": "phoneNumber", "17-0": "reserved1", "18-0": "reserved2", "19-0": "reserved3", "20-0": "reserved4", "6-1": "An array of location objects", "7-1": "Name of the vehicle", "9-1": "Last activity of the vehicle", "10-1": "Speed of the vehicle", "11-1": "Unique identifier representing the vehicle", "8-1": "Timestamp in UTC when the last activity occured", "12-1": "Time between the last ignition OFF and the current system time", "14-1": "Unique identifier of the group associated with the vehicle", "15-1": "Name of the group associated with the vehicle", "16-1": "Phone number of the driver", "17-1": "Reserved variable for future use", "18-1": "Reserved variable for future use", "19-1": "Reserved variable for future use", "20-1": "Reserved variable for future use", "21-0": "latitude", "22-0": "longitutde", "23-0": "location", "21-1": "Latitude coordinate of the location", "22-1": "Longitude coordinate of the location", "23-1": "Address of the location", "13-0": "idleTime", "13-1": "Time period during which the vehicle was in the idle state" }, "cols": 2, "rows": 24 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}