Leaderboard Seasons

Description

A Leaderboard Season resource represents a wrapper for Leaderboards. Based on points acquired by performing well in competitive campaigns, participants will be ranked against each other - within a given time frame. This endpoint allows customers to obtain information about all Leaderboard Seasons in the system.

Fields

Leaderboard Season

Name	Description	Type	Supported Methods
Id	Represents the id of the Leaderboard Season in our system.	long	GET
Name	Name of a given Leaderboard Season	string	GET
StartDate	Start of the time period (See dateformat)	datetime	GET
EndDate	End of the time period (See dateformat)	datetime	GET
PrivateLeaderboardsEnabled	States if participants can create their own Leaderboards in given Leaderboard Season	long	GET
DemographicFieldId	Configurable field, which segregates participants based on option they selected	string	GET
IntervalGroupings	Wrapper for intervals	array	GET

Leaderboard Interval Grouping

Name	Description	Type	Supported Methods
Name	Name of a given Interval Grouping	string	GET
Intervals	Intervals for given time ranges	array	GET

Leaderboard Interval

Name	Description	Type	Supported Methods
Id	Represents the id of the Leaderboard Interval in our system.	long	GET
Name	Name of a given Interval	string	GET
StartDate	Start of the time period (See dateformat)	datetime	GET
EndDate	End of the time period (See dateformat)	datetime	GET

Fetch a Leaderboard Season

Endpoint

GET https://api.crowdmanager.io/v2/{orgId}/mypage/leaderboards/leaderboardseasons

Warning The endpoint uses application/json content type instead of application/vnd.api+json used by most other endpoints in the API. The Accept header is entirely optional.

Example

Request

GET https://api.crowdmanager.io/v2/{orgId}/mypage/leaderboards/leaderboardseasons
Authorization: Basic aaabbbccc111222333
Content-Type: application/json

Response

200 Ok
[{
    "id": 12323,
    "name": "Season Name",
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-05-05T00:00:00Z",
    "privateLeaderboardsEnabled": true,
    "demographicFieldId": "demoFieldId"
    "intervalGroupings": [{
        "name": "Months",
        "intervals": [{
            "id": 1,
            "name": "January",
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-01-31T00:00:00Z",
            },
            {...},
            ...]
    },
    {...},
    ...]
},
{...},
...]

Errors

Code	Error Message
404	LeaderboardSeason not found