api/v1/customer/gamification/leaderboard

POST

/api/v1/customer/gamification/leaderboard

This API method will return all the EIP leaderboard items based on location and filters

Request Parameters

Parameter	Value / Type	Required
eip_campaign_id	STRING	false
rank_on	STRING	false

Sample Response

{
    "status": true,
    "items": [
        {
            "employee_id": "2qMAbl7VEqJPenXgQD8p",
            "employee_name": "Paul Scott",
            "avatar": "http://controlcenter.ftx/customer/images/avatar/dynamic/2qMAbl7VEqJPenXgQD8p/thumb?v=1628245802",
            "rank": 0,
            "total_runs": "83",
            "total_hits": 0,
            "total_doubles": 0,
            "total_triples": 0
        },
        {
            "employee_id": "QD59AxOJm2MenXb14Pw7",
            "employee_name": "Test first 3 Test last 3",
            "avatar": "http://controlcenter.ftx/customer/images/avatar/dynamic/QD59AxOJm2MenXb14Pw7/thumb?v=1626353248",
            "rank": 0,
            "total_runs": "2",
            "total_hits": 0,
            "total_doubles": 0,
            "total_triples": 0
        }
    ]
}

{
    "status": false,
    "errorCode": "VALIDATION_EXCEPTION",
    "messages": {
        "location_id": [
            "The location id field is required."
        ]
    }
}

{
    "status": false,
    "message": "Rank on value must be either one of run, hit, double or triple"
}