leaderboard

Use the /leaderboard endpoint to get the leaderboard of the top 10 subscribers in your list.

Example URI
https://maitreapp.co/api/v1/list/leaderboard?uuid=XXX&api_token=YYY


URI Parameters

uuid string
(required) Your widget UUID.

api_token string
(required) Your api_token.


Response

200  success

{
  status: "ok",
  data: {
    last_updated_at: 1423109311, //Timestamp of last update
    ranking: {
      { email: "jo*****om", people_referred: 30, points: 60 },
      { email: "me*****om", people_referred: 26, points: 52 },
      { email: "lu*****om", people_referred: 18, points: 36 }
      ...
      ...
    }
  }
  calls_left: 482, //Api calls left for this hour
  timestamp: 1469109759 //Timestamp request
}

4XX  error

{
  status: "error",
  message: "Error explanation" // Eg: Missing API token
  code: "error_code" // Eg: no_token
}

Possible error codes

  • no_token
  • no_list_uuid
  • invalid_list_or_token
  • too_many_calls

Still need help? Contact Us Contact Us