{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/profile/info.json","auth":"required","method":"get","params":[{"name":"lastSyncTime","type":"string","default":"","desc":"Timestamp of the last update","required":false,"in":"query","ref":"","_id":"56418dae38e37e0d0049fe4c"},{"name":"averageDays","type":"int","default":"7","desc":"Time period (weekly, monthly or quaterly) for which the records need to be fetched","required":false,"in":"query","ref":"","_id":"56418dae38e37e0d0049fe4b"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"profileFeed\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"generatedAtInMillis\":1451385180715,\n      \"profileInfo\":{  \n         \"userName\":\"tommy:::at:::azuga.com\",\n         \"deviceSerialNum\":null,\n         \"vehicleName\":\"Toms truck\",\n         \"fleetScore\":95,\n         \"pendingRewardCount\":26,\n         \"processedRewardCount\":21\n      },\n      \"privileges\":[  \n         {  \n            \"k\":\"SCORE_ALLOW_COMPARE\",\n            \"v\":\"1\"\n         }\n      ],\n      \"preferences\":[  \n         {  \n            \"k\":\"currency\",\n            \"v\":\"$\"\n         }\n      ]\n   }\n}","name":""}]},"settings":"559288b86bf22f170075b794","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Profile","type":"endpoint","slug":"profile","excerpt":"This API provides you with information about your profile on Azuga. User profile contains details about your Azuga account, privileges, scores, rewards, contact information etc.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/profile/info.json?averageDays=30&lastSyncTime=1449042348000\"\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\": \"generatedAtInMillis\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-0\": \"userName\",\n    \"4-0\": \"deviceSerialNum\",\n    \"5-0\": \"vehicleName\",\n    \"6-0\": \"fleetScore\",\n    \"7-0\": \"pendingRewardCount\",\n    \"8-0\": \"processedRewardCount\",\n    \"9-0\": \"privileges\",\n    \"10-0\": \"k\",\n    \"3-1\": \"Username of the user\",\n    \"4-1\": \"Serial number of the device\",\n    \"5-1\": \"Name of the vehicle\",\n    \"6-1\": \"Overall score of the driver\",\n    \"7-1\": \"Number of rewards pending\",\n    \"8-1\": \"Number of rewards redeemed\",\n    \"11-0\": \"v\",\n    \"12-0\": \"preferences\",\n    \"9-1\": \"An array of privileges objects\",\n    \"12-1\": \"An array of preferences objects\",\n    \"10-1\": \"Key field\",\n    \"11-1\": \"Value associated with the key field\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\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":[],"order":9,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56418c259f4ed50d008be062","createdAt":"2015-11-10T06:18:13.515Z","githubsync":"","parentDoc":null,"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"},"__v":1,"editedParams2":true,"project":"55926c913735880d005f7c65","user":"55926c39cf9cdb2100b57022","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}

getProfile

This API provides you with information about your profile on Azuga. User profile contains details about your Azuga account, privileges, scores, rewards, contact information etc.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

lastSyncTime:
string
Timestamp of the last update
averageDays:
integer7
Time period (weekly, monthly or quaterly) for which the records need to be fetched

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/profile/info.json?averageDays=30&lastSyncTime=1449042348000" } [/block] ##API Response explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "1-0": "message", "2-0": "generatedAtInMillis", "0-1": "API Status Code", "1-1": "API Message", "2-1": "API generation timestamp in UTC", "3-0": "userName", "4-0": "deviceSerialNum", "5-0": "vehicleName", "6-0": "fleetScore", "7-0": "pendingRewardCount", "8-0": "processedRewardCount", "9-0": "privileges", "10-0": "k", "3-1": "Username of the user", "4-1": "Serial number of the device", "5-1": "Name of the vehicle", "6-1": "Overall score of the driver", "7-1": "Number of rewards pending", "8-1": "Number of rewards redeemed", "11-0": "v", "12-0": "preferences", "9-1": "An array of privileges objects", "12-1": "An array of preferences objects", "10-1": "Key field", "11-1": "Value associated with the key field" }, "cols": 2, "rows": 13 } [/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 }}