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

EXAMPLES

Name

Required

String

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

Description

Optional

String

The description of the Contest that can be used to explain the Contest to players.
Scoring strategy

Required

Enum

Scoring strategies are used for the leaderboard to populate the leaderboard depending on what kind of competition you want to run. The basic one is "The sum of all the points a player scores during the contest (Cumulative)" - in short all the points of the participants will be summed up and populated in the leaderboard.

Ranking

Required

Model

The Ranking can be from the smallest score to the biggest or the other way around. You can also make the ranking of the participants that have the same amount of points to be in the same rank or different rank depending on the time they sent the last event. 


Metadata

Optional

Array [Object]

Used for storing information relevant to your backend systems. 

APP Example:

Name
Summer Contest!
Description
A contest to commemorate the end of summer!
Scoring strategy
The sum of all the points a player scores during the contest (Cumulative)
Ranking
Scores ranking order
Descending
Time ranking order
Ascending
Rank order by
Score first
Discard time when ranking
No
Discard score when ranking
No
Metadata
KeySummer
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
          }
       }
    ...
}

A full example of POST Contest can be found in the Contest APP API documentation here


CONTINUE Click Next and continue to the next step.

MISSING ENTRIES If any required information is missing, the field is shown in red as in the example below.