These docs are for v1. Click to read the latest docs for v3.

Reward History

This API provides you with information of rewards that have been awarded to drivers. Rewards are gift cards given to drivers based on their driving behaviour. The API response includes status of the rewards, reward amount, driver names etc.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Sample Request

https://api.azuga.com/azuga-ws/v1/rewards/history.json?fromDate=1448955906000&toDate=1451375106000&status=all

API Response explanation

FieldDescription
codeAPI Status Code
messageAPI Message
reasonReason for failure
generatedAtInMillisAPI generation timestamp in milliseconds
rewardsHistoryAn array of rewardsHistory objects
driverNameName of the driver
rewardIdUnique identifier of the reward
rewardAmountAmount that has been rewarded to the driver
rewardSubjectSubject of the Reward
rewardMessageMessage from the supervisor in the reward
brandBrand at which the reward was redeemed
statusStatus of the reward
sentAtTimestamp at which the reward was sent (in milliseconds)
senderSender of the reward
vehicleNameName of the vehicle
redeemedAtTimestamp at which the reward was redeemed (in milliseconds)
redemptionCodeCode for redeeming the reward
challengeKeyPIN used for obtaining the redemption code
brandIdUnique identifier of the brand
🚧

Disclaimer

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.

Query Params
date-time
required

Start date of the period for which details need to be retrieved (in milliseconds)

date-time
required

End date of the period for which details need to be retrieved (in milliseconds)

string

Status of the reward i.e. whether it is pending or redeemed

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json