Schema Viewer
Viewing v2/runtime/leaderboards/:leaderboard_definition_id/get.json
{
  "id": "https://dev.playlyfe.com/schemas/v2/runtime/leaderboards/:leaderboard_definition_id/get.json",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "params",
    "query"
  ],
  "properties": {
    "params": {
      "$ref": "https://dev.playlyfe.com/schemas/v2/common/component.json"
    },
    "query": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "cycle"
      ],
      "properties": {
        "ranking": {
          "type": "string",
          "enum": [
            "normal",
            "relative"
          ],
          "default": "normal"
        },
        "cycle": {
          "type": "string",
          "enum": [
            "alltime",
            "daily",
            "weekly",
            "monthly",
            "yearly"
          ]
        },
        "sort": {
          "type": "string",
          "enum": [
            "ascending",
            "descending"
          ],
          "default": "descending"
        },
        "skip": {
          "type": "string",
          "format": "positiveLongInteger",
          "default": "0"
        },
        "limit": {
          "type": "string",
          "format": "positiveLongInteger",
          "default": "10"
        },
        "radius": {
          "type": "string",
          "format": "positiveLongInteger",
          "default": "5"
        },
        "merge_with": {
          "type": "string",
          "default": ""
        }
      }
    }
  }
}