{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/breadcrumb/location.json","auth":"required","params":[{"name":"vehicleName","type":"string","default":"","desc":"Name of the vehicle","required":true,"in":"query","ref":"","_id":"5631ae79fa40240d007c8cb4"},{"name":"from","type":"string","default":"","desc":"Trip start timestamp in UTC with format mm-dd-yyyy HH:mm:ss","required":true,"in":"query","ref":"","_id":"5631ae79fa40240d007c8cb3"},{"name":"to","type":"string","default":"","desc":"Trip end timestamp in UTC with format mm-dd-yyyy HH:mm:ss","required":true,"in":"query","ref":"","_id":"5631ae79fa40240d007c8cb2"},{"name":"page","type":"int","default":"1","desc":"Page number of the paginated result","required":false,"in":"query","ref":"","_id":"5631ae79fa40240d007c8cb1"}],"results":{"codes":[{"language":"json","code":"{  \n   \"breadcrumbResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Dec-16-2015, 10:40 AM UTC\",\n      \"currentPage\":1,\n      \"totalPages\":1,\n      \"breadcrumbs\":[  \n         {  \n            \"vehicleId\":\"c148cc80-58fd-11e2-804a-19707e3e1e71\",\n            \"groupId\":\"dfa9fdda-2c0e-11e2-b5be-8f69786b759a\",\n            \"groupName\":\"West Coast\",\n            \"phoneNumber\":\"\",\n            \"date\":\"Dec-15-2015, 11:28 AM UTC\",\n            \"event\":\"Connected/Disconnected\",\n            \"speed\":\"\",\n            \"latitude\":37.366791,\n            \"longitude\":-121.918167,\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"vehicleName\":\"Daniel's car\",\n            \"location\":\"1731 Technology Drive, San Jose, CA 95110, USA\"\n         },\n         {  \n            \"vehicleId\":\"c148cc80-58fd-11e2-804a-19707e3e1e71\",\n            \"groupId\":\"dfa9fdda-2c0e-11e2-b5be-8f69786b759a\",\n            \"groupName\":\"West Coast\",\n            \"phoneNumber\":\"\",\n            \"date\":\"Dec-15-2013, 11:28 AM UTC\",\n            \"event\":\"Connected/Disconnected\",\n            \"speed\":\"\",\n            \"latitude\":37.366791,\n            \"longitude\":-121.918167,\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"vehicleName\":\"Daniel's car\",\n            \"location\":\"1731 Technology Drive, San Jose, CA 95110, USA\"\n         },\n         {  \n            \"vehicleId\":\"c148cc80-58fd-11e2-804a-19707e3e1e71\",\n            \"groupId\":\"dfa9fdda-2c0e-11e2-b5be-8f69786b759a\",\n            \"groupName\":\"West Coast\",\n            \"phoneNumber\":\"\",\n            \"date\":\"Dec-15-2015, 11:30 AM UTC\",\n            \"event\":\"VIN Changed (device switched)\",\n            \"speed\":\"\",\n            \"latitude\":37.366791,\n            \"longitude\":-121.918167,\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"vehicleName\":\"Daniel's car\",\n            \"location\":\"1731 Technology Drive, San Jose, CA 95110, USA\"\n         },\n         {  \n            \"vehicleId\":\"c148cc80-58fd-11e2-804a-19707e3e1e71\",\n            \"groupId\":\"dfa9fdda-2c0e-11e2-b5be-8f69786b759a\",\n            \"groupName\":\"West Coast\",\n            \"phoneNumber\":\"\",\n            \"date\":\"Dec-15-2015, 11:30 AM UTC\",\n            \"event\":\"Ignition On\",\n            \"speed\":\"\",\n            \"latitude\":37.366791,\n            \"longitude\":-121.918167,\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"vehicleName\":\"Daniel's car\",\n            \"location\":\"1731 Technology Drive, San Jose, CA 95110, USA\"\n         },\n         {  \n            \"vehicleId\":\"c148cc80-58fd-11e2-804a-19707e3e1e71\",\n            \"groupId\":\"dfa9fdda-2c0e-11e2-b5be-8f69786b759a\",\n            \"groupName\":\"West Coast\",\n            \"phoneNumber\":\"\",\n            \"date\":\"Dec-15-2015, 11:31 AM UTC\",\n            \"event\":\"Ignition Off\",\n            \"speed\":\"\",\n            \"latitude\":37.366791,\n            \"longitude\":-121.918167,\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null,\n            \"vehicleName\":\"Daniel's car\",\n            \"location\":\"1731 Technology Drive, San Jose, CA 95110, USA\"\n         }\n      ]\n   }\n}","name":"","status":200}]},"settings":"559288b86bf22f170075b794","examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Breadcrumb","type":"endpoint","slug":"breadcrumb","excerpt":"This API provides you with a breadcrumb trail of your vehicle’s movement for any day. This trail is as precise as the tracking interval defined. For example, if your tracking interval was set at 1 minute, this API will provide you with 1440 result set for a particular day for a specific vehicle.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/breadcrumb/location.json?vehicleName=Daniel's car&from=12-15-2015 00:00:00&to=12-15-2015 23:59:59\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"code\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\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\": \"breadcrumbs\",\n    \"7-0\": \"vehicleId\",\n    \"8-0\": \"groupId\",\n    \"9-0\": \"groupName\",\n    \"10-0\": \"phoneNumber\",\n    \"11-0\": \"date\",\n    \"12-0\": \"event\",\n    \"6-1\": \"An array of breadcrumb objects\",\n    \"7-1\": \"Unique identifier representing the vehicle\",\n    \"8-1\": \"Unique identifier of the group associated with the vehicle\",\n    \"9-1\": \"Name of the group associated with the vehicle\",\n    \"10-1\": \"Phone number of the driver\",\n    \"11-1\": \"Timestamp in UTC when the event occured\",\n    \"12-1\": \"Name of the event\",\n    \"13-0\": \"speed\",\n    \"14-0\": \"latitude\",\n    \"15-0\": \"longitude\",\n    \"16-0\": \"reserved1\",\n    \"17-0\": \"reserved2\",\n    \"18-0\": \"reserved3\",\n    \"19-0\": \"reserved4\",\n    \"13-1\": \"Average speed of the vehicle\",\n    \"14-1\": \"Latitude coordinate of the location\",\n    \"15-1\": \"Longitude coordinate of the location\",\n    \"16-1\": \"Reserved variable for future use\",\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-0\": \"vehicleName\",\n    \"21-0\": \"location\",\n    \"20-1\": \"Name of the vehicle\",\n    \"21-1\": \"Address of the location\"\n  },\n  \"cols\": 2,\n  \"rows\": 22\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5631abc1fc94aa0d00e9b5e6","__v":3,"editedParams":true,"editedParams2":true,"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"},"createdAt":"2015-10-29T05:16:49.182Z","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"},"githubsync":"","parentDoc":null,"project":"55926c913735880d005f7c65","user":"55926c39cf9cdb2100b57022"}

getBreadcrumb

This API provides you with a breadcrumb trail of your vehicle’s movement for any day. This trail is as precise as the tracking interval defined. For example, if your tracking interval was set at 1 minute, this API will provide you with 1440 result set for a particular day for a specific vehicle.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

vehicleName:
required
string
Name of the vehicle
from:
required
string
Trip start timestamp in UTC with format mm-dd-yyyy HH:mm:ss
to:
required
string
Trip end timestamp in UTC with format mm-dd-yyyy HH:mm:ss
page:
integer1
Page number of the paginated result

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/breadcrumb/location.json?vehicleName=Daniel's car&from=12-15-2015 00:00:00&to=12-15-2015 23:59:59" } [/block] ##API Response explanation [block:parameters] { "data": { "0-0": "code", "h-0": "Field", "h-1": "Description", "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": "breadcrumbs", "7-0": "vehicleId", "8-0": "groupId", "9-0": "groupName", "10-0": "phoneNumber", "11-0": "date", "12-0": "event", "6-1": "An array of breadcrumb objects", "7-1": "Unique identifier representing the vehicle", "8-1": "Unique identifier of the group associated with the vehicle", "9-1": "Name of the group associated with the vehicle", "10-1": "Phone number of the driver", "11-1": "Timestamp in UTC when the event occured", "12-1": "Name of the event", "13-0": "speed", "14-0": "latitude", "15-0": "longitude", "16-0": "reserved1", "17-0": "reserved2", "18-0": "reserved3", "19-0": "reserved4", "13-1": "Average speed of the vehicle", "14-1": "Latitude coordinate of the location", "15-1": "Longitude coordinate of the location", "16-1": "Reserved variable for future use", "17-1": "Reserved variable for future use", "18-1": "Reserved variable for future use", "19-1": "Reserved variable for future use", "20-0": "vehicleName", "21-0": "location", "20-1": "Name of the vehicle", "21-1": "Address of the location" }, "cols": 2, "rows": 22 } [/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 }}