Admin API

Create new Leaderboard Schedule

POST

https://api.lootlocker.io/admin/game/{game_id}/leaderboard/{leaderboard_id}/schedule

leaderboardsschedulescron

Cron Expressions

You can use cron expressions to define your schedule.
These expressions follow the traditional cron spec.

A great tool to familiarise yourself with it is crontab guru.

Additionally, we do support non-standard descriptors as follows:

@daily: everyday, at midnight UTC.

@weekly: on Sunday, at midnight UTC.

@monthly on the first day of the month, at midnight UTC.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.lootlocker.io/admin/game//leaderboard/{{leaderboard_id}}/schedule' \
--header 'Content-Type: application/json' \
--header 'x-auth-token;' \
--data-raw '{
    "cron_expression": "@daily"
}'

Response Example

200 - Success

{
    "next_run": "2024-02-25T04:05:00Z",
    "schedule": [
        "2024-02-25T04:05:00Z",
        "2024-03-03T04:05:00Z",
        "2024-03-10T04:05:00Z",
        "2024-03-17T04:05:00Z",
        "2024-03-24T04:05:00Z"
    ]
}

Request

Authorization

API Key

Add parameter in header

x-auth-token

Example:

x-auth-token: ********************

Path Params

game_id

string

required

Example:

leaderboard_id

string

required

Example:

Header Params

x-auth-token

string

optional

Example:

Body Params application/json

cron_expression

string

required

Example: 5 4 * * sun, which means At 04:05 on Sunday.

Examples

Responses

🟢200OK

application/json

Body

next_run

string

required

schedule

array[string]

required

<= 5 items

🟠400Invalid Request Body

Modified at 2024-07-31 08:01:01

Rename

Get Leaderboard Schedule

Create new Leaderboard Schedule

Cron Expressions#

Request

Responses

Cron Expressions