Update a runtime leaderboard

PATCH

https://api.eu-west-1.aworld.cloud/dashboard/v1/runtime-leaderboards/{runtimeLeaderboardId}

Updates runtime leaderboard configuration. If timeframe fields are changed, the state and periodId are automatically recalculated.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Runtime leaderboard updated successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.eu-west-1.aworld.cloud/dashboard/v1/runtime-leaderboards/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "runtimeLeaderboardConfigurationId": "string",
    "timeframeType": "PERMANENT",
    "timeframeTimezoneType": "FIXED",
    "timeframeTimezone": "Europe/Andorra",
    "timeframeStartsAt": "2019-08-24T14:15:22.123Z",
    "timeframeEndsAt": "2019-08-24T14:15:22.123Z",
    "recurrence": "DAILY"
}'

Response Example

{
    "runtimeLeaderboardId": "string",
    "runtimeLeaderboardConfigurationId": "string",
    "periodId": "string",
    "timeframeType": "PERMANENT",
    "timeframeTimezoneType": "FIXED",
    "timeframeTimezone": "Europe/Andorra",
    "timeframeStartsAt": "2019-08-24T14:15:22.123Z",
    "timeframeEndsAt": "2019-08-24T14:15:22.123Z",
    "state": "PENDING",
    "recurrence": "DAILY",
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-02-10 10:38:26

Get a runtime leaderboard by ID

List runtime leaderboard configurations