Returning.AI

create new leaderboard

Developing

POST

/leaderboards

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

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:

image

file

optional

rankBy

string

optional

Example:

timeFilters

array[string]

optional

Example:

["all-time","daily","monthly"]

displayedFields

array[string]

optional

Example:

["first","last","server_roles"]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.returning.ai/api/v1/leaderboards' \
--form 'name="Genesiv Leaderboard"' \
--form 'description="This is the description for '\''Genesiv'\''"' \
--form 'serverId=""' \
--form 'image=@""' \
--form 'rankBy="XP"' \
--form 'timeFilters="all-time"' \
--form 'timeFilters="daily"' \
--form 'timeFilters="monthly"' \
--form 'displayedFields="first"' \
--form 'displayedFields="last"' \
--form 'displayedFields="server_roles"'

Responses

🟢200Success

application/json

Body

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 2024-08-07 03:45:00

delete language setting

update leaderboard