Step 1: Contest settings

This is the first step to create a new Contest. Some fields are mandatory some are optional. You can check more about the Contests model in our API documentation Contests.

SETTINGS fields

EXAMPLES

» Name String

Mandatory

The Name of the Contest. The sample Javascript for the CompetitionLabs leaderboard shows this name.
» Description String

Optional

The description of the Contest is used to explain the Contest to players.
» Scoring strategy Enum

Mandatory

Scoring strategies populate the leaderboard according to the kind of competition you want to create. The basic one is “The sum of all the points a player scores during the contest” (Cumulative) where all points scored by participants are shown in the leaderboard.

 

You can read ‘Tips and Tricks’ and more about possible scoring strategies here

» Ranking Model

Mandatory

Ranking can be from the lowest to the highest score or the other way around. You can also rank participants who have the same score equally, or according to when they completed the last event.

 

NOTE! Certain ranking strategies cannot be True at the same time. Scores in descending order and Time in descending order are not compatible, so one of them has to be True the other False. The same applies to Ignore Time and Ignore Score.

Ranking strategies are pre-selected to function correctly. Modifying the Ranking will impact your leaderboard, so if you make changes, please test before using it.

» Metadata Array[Object]

Optional

Used for storing information in your back-end system.

 

APP Example:

NameSummer Contest!
DescriptionA contest to commemorate the end of summer!
Scoring strategyThe sum of all the points a player scores during the contest (Cumulative)
Ranking: Scores ranking orderDescending
Ranking: Time ranking orderAscending
Ranking: Rank order byScore first
Ranking: Discard time when rankingNo
Ranking: Discard score when rankingNo
Metadata: KeySummer
Metadata: Value2

API Example:

{
    "jsonClass": "Contest",
    ...
    "label": "Summer Contest",
    "description": "A contest to commemorate the end of summer!",
    "metadata": [
        {        
            "jsonClass": "Metadata",
                "key": "Summer",
                "value": "2"
            }
        ],

     "strategies": {
         "jsonClass": "Strategies",
         "strategyType": "TotalCumulative",
         "rankingStrategy": {
             "jsonClass": "RankingStrategy",
             "scoreDesc": true,
             "timeDesc": false,
             "scoreFirst": true,
             "ignoreTime": false,
             "ignoreScore": false
             },
         "scoringStrategy": {
             "jsonClass": "ScoringStrategy",
             "limitUpdatesTo": 0,
             "sumBestXOf": 0,
             "lastUpdateTimeStamp": 0,
             "recordTimeWhenSumReaches": 0.0
             }
         }

    ...
}

The API example provides only a simplified version of the POST body. A full example of POST Contest can be found in the Contest APP API documentation here

If any mandatory fields are missing, the field is shown in red, as in the example below.

MISSING ENTRIES

CONTINUE – Click Next and continue to the next step.

Back To Top