How to create a custom leaderboard

Leaderboard is currently an experimental feature and requires some technical skill to be implemented.

To enable this feature you must set the property require_leaderboard to"true" when initialising the Maître object.

<script type="text/javascript">

  window.Maitre = {
    uuid: MFXXXX,
    require_leaderboard: true
  };

</script>

When require_leaderboard is set to "true", the json object that is sent as response to a form submission will contain the property "leaderboard".

This property is an object that contains two values:

  • last_updated_at: timestamp of the last time the list was updated (lists are updated every 10-15 minutes)
  • ranking: object containing the top 10 subscribers in ascendent order

The leaderboard object will look like this: 

{
  last_updated_at: 1460026215,
  ranking: [
    { email: "m.******om", referred: 19 },
    { email: "re******m2", referred: 12 },
    { email: "kj******co", referred: 0}
  ]
}

By default all emails in the leaderboard are modified to prevent malicious activity, but if the subscriber submitting the form is present in the leaderboard, his/her email will be visible.

Please get in touch if you need help implementing this feature.

Still need help? Contact Us Contact Us