{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/score/list.json","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"averageDays","type":"int","default":"7","desc":"Time period for comparing average driver score i.e weekly, monthly or quaterly","required":false,"in":"query","ref":"","_id":"5641880f03881c0d00ac215a"},{"name":"comparingPool","type":"int","default":"0","desc":"Comparing pool i.e. whether to compare scores with a group or entire organization","required":false,"in":"query","ref":"","_id":"5641880f03881c0d00ac2159"},{"name":"startIndex","type":"int","default":"0","desc":"Starting index from which records need to be fetched","required":false,"in":"query","ref":"","_id":"5641880f03881c0d00ac2158"},{"name":"limit","type":"int","default":"10","desc":"Number of results to return per page","required":false,"in":"query","ref":"","_id":"5641880f03881c0d00ac2157"}],"results":{"codes":[{"status":200,"name":"","code":"{  \n   \"scoreFeed\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":null,\n      \"generatedAtInMillis\":1451385149380,\n      \"trendFeed\":{  \n         \"trends\":{  \n\n         }\n      },\n      \"milesDriven\":3490.49,\n      \"userCount\":1,\n      \"scores\":[  \n         {  \n            \"rank\":1,\n            \"userId\":\"438715de-4130-11e5-bc76-81edf3745863\",\n            \"firstName\":\"Jake\",\n            \"lastName\":\"Finch\",\n            \"averageDays\":0,\n            \"fleetScore\":100,\n            \"username\":\"jake:::at:::azuga.com\",\n            \"profilePicture\":\"https://azugaprofilepic.s3.amazonaws.com/newton/438715de-4130-11e5-bc76-81edf3745863_1445315826098\",\n            \"speedScore\":99,\n            \"brakeScore\":95,\n            \"hardAccelarationScore\":98,\n            \"idleScore\":98\n         },\n         {  \n            \"rank\":2,\n            \"userId\":\"16770110-fa9f-11e3-8c9c-22000af87506\",\n            \"firstName\":\"Erik\",\n            \"lastName\":\"Leopold\",\n            \"averageDays\":0,\n            \"fleetScore\":100,\n            \"username\":\"[email protected]\",\n            \"profilePicture\":null,\n            \"speedScore\":90,\n            \"brakeScore\":94,\n            \"hardAccelarationScore\":99,\n            \"idleScore\":89\n         }\n      ]\n   }\n}","language":"json"}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"Score","type":"endpoint","slug":"score","excerpt":"Use this API to fetch scores of all drivers present in your account. Scores are points given to the drivers based on their driving behavior. The overall score is based on the scores of hard braking, hard acceleration, speeding and idling. This API also helps you determine the rank of each driver.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/score/list.json?averageDays=30&comparingPool=0&startIndex=0&limit=10\"\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    \"3-0\": \"generatedAtInMillis\",\n    \"2-0\": \"reason\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message\",\n    \"3-1\": \"API generation timestamp in milliseconds\",\n    \"2-1\": \"Reason for failure\",\n    \"4-0\": \"milesDriven\",\n    \"5-0\": \"userCount\",\n    \"6-0\": \"scores\",\n    \"7-0\": \"rank\",\n    \"8-0\": \"userId\",\n    \"9-0\": \"firstName\",\n    \"10-0\": \"lastName\",\n    \"11-0\": \"averageDays\",\n    \"12-0\": \"fleetScore\",\n    \"13-0\": \"username\",\n    \"14-0\": \"profilePicture\",\n    \"15-0\": \"speedScore\",\n    \"16-0\": \"brakeScore\",\n    \"17-0\": \"hardAccelarationScore\",\n    \"18-0\": \"idleScore\",\n    \"4-1\": \"Cumulative miles driven by the drivers\",\n    \"5-1\": \"Number of drivers whose scores are fetched\",\n    \"6-1\": \"An array of scores objects\",\n    \"7-1\": \"Rank of the driver\",\n    \"8-1\": \"Unique identifier representing the user\",\n    \"9-1\": \"First name of the driver\",\n    \"10-1\": \"Last name of the driver\",\n    \"12-1\": \"Overall score of the driver\",\n    \"13-1\": \"Username of the driver\",\n    \"14-1\": \"URL of the profile picture of the driver\",\n    \"15-1\": \"Score for speeding\",\n    \"16-1\": \"Score for braking\",\n    \"17-1\": \"Score for hard acceleration\",\n    \"18-1\": \"Score for idling\",\n    \"11-1\": \"Time period for comparing average driver score i.e weekly, monthly or quaterly\"\n  },\n  \"cols\": 2,\n  \"rows\": 19\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This API provides information only for a driver and does not provide aggregated information for a group of vehicles. Admins should not use these APIs, but should look at other sections of the documentation.\",\n  \"title\": \"Disclaimer\"\n}\n[/block]","updates":["5df2c0763dc522004af54ad2"],"order":8,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5641842903881c0d00ac2155","category":{"sync":{"isSync":false,"url":""},"pages":["55928fd16bf22f170075b7b4","5592bd5a6bf22f170075b851","56416d6803881c0d00ac214b","5641702a03881c0d00ac214d","56417262b0dc090d00f88396","5641748f9f4ed50d008be04d","56417a76f424a10d00118215","56417c7b9417b40d00c0fbc6","56417f7f9417b40d00c0fbca","5641803203881c0d00ac2153","5641842903881c0d00ac2155","56418c259f4ed50d008be062","56418e30b0dc090d00f883a6","564192599417b40d00c0fbd1","564195c403881c0d00ac2162","5641988502fe811900f076c3","5641b8dc03881c0d00ac217c","5641c06238e37e0d0049fe6b","5656e88da795770d00a2aee0"],"title":"MOBILE","slug":"fleet-mobile","order":1,"from_sync":false,"reference":true,"_id":"55928a98c39c4b2d00127a83","version":"559286c6c39c4b2d00127a71","project":"55926c913735880d005f7c65","__v":19,"createdAt":"2015-06-30T12:24:56.461Z"},"editedParams":true,"parentDoc":null,"__v":4,"editedParams2":true,"createdAt":"2015-11-10T05:44:09.139Z","githubsync":"","project":"55926c913735880d005f7c65","user":"55926c39cf9cdb2100b57022","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"}}

getScore

Use this API to fetch scores of all drivers present in your account. Scores are points given to the drivers based on their driving behavior. The overall score is based on the scores of hard braking, hard acceleration, speeding and idling. This API also helps you determine the rank of each driver.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

averageDays:
integer7
Time period for comparing average driver score i.e weekly, monthly or quaterly
comparingPool:
integer0
Comparing pool i.e. whether to compare scores with a group or entire organization
startIndex:
integer0
Starting index from which records need to be fetched
limit:
integer10
Number of results to return per page

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/score/list.json?averageDays=30&comparingPool=0&startIndex=0&limit=10" } [/block] ##API Response explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "1-0": "message", "3-0": "generatedAtInMillis", "2-0": "reason", "0-1": "API Status Code", "1-1": "API Message", "3-1": "API generation timestamp in milliseconds", "2-1": "Reason for failure", "4-0": "milesDriven", "5-0": "userCount", "6-0": "scores", "7-0": "rank", "8-0": "userId", "9-0": "firstName", "10-0": "lastName", "11-0": "averageDays", "12-0": "fleetScore", "13-0": "username", "14-0": "profilePicture", "15-0": "speedScore", "16-0": "brakeScore", "17-0": "hardAccelarationScore", "18-0": "idleScore", "4-1": "Cumulative miles driven by the drivers", "5-1": "Number of drivers whose scores are fetched", "6-1": "An array of scores objects", "7-1": "Rank of the driver", "8-1": "Unique identifier representing the user", "9-1": "First name of the driver", "10-1": "Last name of the driver", "12-1": "Overall score of the driver", "13-1": "Username of the driver", "14-1": "URL of the profile picture of the driver", "15-1": "Score for speeding", "16-1": "Score for braking", "17-1": "Score for hard acceleration", "18-1": "Score for idling", "11-1": "Time period for comparing average driver score i.e weekly, monthly or quaterly" }, "cols": 2, "rows": 19 } [/block] [block:callout] { "type": "warning", "body": "This API provides information only for a driver and does not provide aggregated information for a group of vehicles. Admins should not use these APIs, but should look at other sections of the documentation.", "title": "Disclaimer" } [/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 }}