Returning.AI
Light Mode
create new leaderboard
DevelopingPOST
/leaderboardsRequest
Body Params multipart/form-data
name
string
optional
Example:
Genesiv Leaderboard
description
string
optional
Example:
This is the description for 'Genesiv'
serverId
string
optional
Example:
{{serverId}}
image
file
optional
rankBy
string
optional
Example:
XP
timeFilters
array[string]
optional
Example:
["all-time","daily","monthly"]
displayedFields
array[string]
optional
Example:
["first","last","server_roles"]
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
serverId
string
optional
enabled
boolean
optional
name
string
optional
description
string
optional
leaderImage
string
optional
timeFilters
array[string]
optional
rankBy
string
optional
displayedFields
array[string]
optional
excludeRoles
array[string]
optional
_id
string
optional
createdAt
string
optional
updatedAt
string
optional
__v
integer
optional
Example
{
"serverId": "66b1dc61c575acfd4180d6f9",
"enabled": false,
"name": "Genesiv Leaderboard",
"description": "This is the description for 'Genesiv'",
"leaderImage": "https://s3.us-east-2.amazonaws.com/chartsnapshot/apireturningai/tester/1722997475467-genesiv_logo.jpeg",
"timeFilters": [
"all-time",
"daily",
"monthly"
],
"rankBy": "XP",
"displayedFields": [
"first",
"last",
"server_roles"
],
"excludeRoles": [],
"_id": "66b2dae4030d67004cbb3236",
"createdAt": "2024-08-07T02:24:36.900Z",
"updatedAt": "2024-08-07T02:24:36.900Z",
"__v": 0
}
Modified at a month ago