scill.json

{
  "openapi" : "3.0.0",
  "info" : {
    "title" : "SCILL API",
    "description" : "SCILL gives you the tools to activate, retain and grow your user base in your app or game by bringing you features well known in the gaming industry: Gamification. We take care of the services and technology involved so you can focus on your game and content.",
    "contact" : {
      "email" : "support@scillgame.com"
    },
    "license" : {
      "name" : "Apache 2.0",
      "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version" : "1.0.0"
  },
  "servers" : [ {
    "url" : "https://virtserver.swaggerhub.com/4Players-GmbH/scill-gaas/1.0.0",
    "description" : "SwaggerHub API Auto Mocking"
  } ],
  "tags" : [ {
    "name" : "auth",
    "description" : "Auth"
  }, {
    "name" : "events",
    "description" : "Events"
  }, {
    "name" : "challenges",
    "description" : "Challenges"
  }, {
    "name" : "battle-passes",
    "description" : "BattlePasses"
  }, {
    "name" : "leaderboardsV2",
    "description" : "Leaderboards V2"
  }, {
    "name" : "leaderboards",
    "description" : "Leaderboards"
  } ],
  "paths" : {
    "/api/v1/auth/access-token" : {
      "description" : "Generate an access token for API-Key and User ID. This access token can be used in subsequent calls to other APIs.",
      "post" : {
        "tags" : [ "auth" ],
        "summary" : "Get an access token for any user identifier signed with the API-Key",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/authentication/#access-tokens"
        },
        "operationId" : "generateAccessToken",
        "requestBody" : {
          "description" : "Foreign user identifier.",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ForeignUserIdentifier"
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "200" : {
            "description" : "Returns the access token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AccessToken"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "500" : {
            "description" : "Failed on server side"
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://us.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://us-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://us-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/auth/user-challenge-topic-link" : {
      "description" : "Request a topic for the MQTT server to receive real time updates if the specified challenge changes for the user. Use the getUserChallengesNotificationTopic operation if you want to get notifications for all challenges.",
      "get" : {
        "tags" : [ "auth" ],
        "summary" : "Get a topic to be used with an MQTT client to receive real time updates whenever the specified challenge changes.",
        "description" : "Get a topic to be used with an MQTT client to receive real time updates whenever the challenge changes.",
        "operationId" : "getUserChallengeNotificationTopic",
        "parameters" : [ {
          "name" : "challenge_id",
          "in" : "query",
          "description" : "The challenge id you want to get notified",
          "required" : true,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Returns the socket token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/NotificationTopic"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/auth/user-challenges-topic-link" : {
      "description" : "Request a topic for the MQTT server to receive real time updates if challenges change for the user. This will return changes for all challenges. If you want to listen only for a specific challenge, use the getUserChallengeNotificationTopic.",
      "get" : {
        "tags" : [ "auth" ],
        "summary" : "Get a topic to be used with an MQTT client to receive real time updates whenever challenges for the user provided by the access token changes.",
        "description" : "Get a topic to be used with an MQTT client to receive real time updates whenever challenges for the user provided by the access token change.",
        "operationId" : "getUserChallengesNotificationTopic",
        "responses" : {
          "200" : {
            "description" : "Returns the socket token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/NotificationTopic"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/auth/user-battle-pass-topic-link" : {
      "description" : "Request a topic for the MQTT server to receive real time updates if battle passes change for the user.",
      "get" : {
        "tags" : [ "auth" ],
        "summary" : "Get a topic to be used with an MQTT client to receive real time updates whenever a battle pass or challenges and levels within the battle pass change",
        "description" : "Get a topic to be used with an MQTT client to receive real time updates whenever a battle pass changes.",
        "operationId" : "getUserBattlePassNotificationTopic",
        "parameters" : [ {
          "name" : "battle_pass_id",
          "in" : "query",
          "description" : "The battle pass you want to get notified",
          "required" : true,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Returns the socket token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/NotificationTopic"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/auth/leaderboard-topic-link" : {
      "description" : "Request a topic for the MQTT server to receive real time updates if the leaderboard for the application changes.",
      "get" : {
        "tags" : [ "auth" ],
        "summary" : "Get MQTT topic for leaderboard",
        "description" : "Get a topic to be used with an MQTT client to receive real time updates whenever the specified leaderboard changes.",
        "operationId" : "getLeaderboardNotificationTopic",
        "parameters" : [ {
          "name" : "leaderboard_id",
          "in" : "query",
          "description" : "The id of the leaderboard you want to get notified",
          "required" : true,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Returns the notification topic",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/NotificationTopic"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://us.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://us-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://us-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/user-additional-info" : {
      "description" : "Provide tools to set additional user info like usernames and avatar images",
      "get" : {
        "tags" : [ "auth" ],
        "summary" : "Get additional info stored per user",
        "description" : "Returns additional info object with usernames and avatar image for a user which is used in the leaderboard system",
        "operationId" : "getUserInfo",
        "responses" : {
          "200" : {
            "description" : "Returns the socket token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/UserInfo"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "put" : {
        "tags" : [ "auth" ],
        "summary" : "Set additional info stored per user",
        "description" : "Sets user info like username and avatar image which is returned as part of the user rankings in leaderboards.",
        "operationId" : "setUserInfo",
        "requestBody" : {
          "description" : "UserInfo object stored in the SCILL database for the user",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/UserInfo"
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "200" : {
            "description" : "Returns the socket token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/UserInfo"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://us.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://us-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://us-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/events" : {
      "description" : "Events are a piece of structured information that your application or application backend sends to SCILL. Those events are processed in real-time to drive challenges and battle passes that you setup in the Admin Panel and that you activate for your users. Events are also stored in the SCILL backend to drive game analytics. Using this API you can create events.",
      "post" : {
        "tags" : [ "events" ],
        "summary" : "Post an event",
        "description" : "Post an event to the SCILL backend",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/events/#sending-events"
        },
        "operationId" : "sendEvent",
        "requestBody" : {
          "description" : "Event payload or team event payload",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/EventPayload"
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "500" : {
            "description" : "Failed on server side"
          },
          "404" : {
            "description" : "The event type is not supported",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/UnknownChallengeError"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ],
          "ApiKeyType" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ep.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ep-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ep-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/public/documentation" : {
      "description" : "Returns a list of available events in the platform with required and optional properties. Used internally for updating documentation and the Admin Panel inline help.",
      "get" : {
        "tags" : [ "events" ],
        "summary" : "Get all available events and required and optional properties",
        "description" : "Get all available events and required and optional properties",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/events/"
        },
        "operationId" : "getAvailableEvents",
        "responses" : {
          "200" : {
            "description" : "An array of EventDescription objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/EventDescription"
                  }
                }
              }
            }
          },
          "500" : {
            "description" : "Failed on server side"
          }
        }
      },
      "servers" : [ {
        "url" : "https://ep.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ep-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ep-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/get/{appId}" : {
      "description" : "Use this endpoint to get all available challenges for your product. This will be personalized for the user encoded in the access token. It will not return completed challenges. Use getAllPersonalChallenges to get completed challenges.",
      "get" : {
        "tags" : [ "challenges" ],
        "summary" : "Get personal challenges that are not yet completed.",
        "description" : "Get personal challenges organized in categories",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#request-challenges"
        },
        "operationId" : "getPersonalChallenges",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "include_categories",
          "in" : "query",
          "description" : "A list of categories that should be included in the response. Only the categories provided will be returned",
          "required" : false,
          "style" : "form",
          "explode" : false,
          "schema" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        }, {
          "name" : "exclude_categories",
          "in" : "query",
          "description" : "A list of categories that should be excluded from the response. All  categories except those listed here will be returned",
          "required" : false,
          "style" : "form",
          "explode" : false,
          "schema" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of ChallengeCategory objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/ChallengeCategory"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/unresolved/{appId}" : {
      "description" : "Use this endpoint to get only active challenges. This returns a list of challenges grouped in categories that are not finished yet. Finished (i.e. completed) challenges will not be returned in this endpoint.",
      "get" : {
        "tags" : [ "challenges" ],
        "summary" : "Get personal challenges that are not yet completed.",
        "description" : "Get personal challenges organized in categories that are not yet finished",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#get-all-unresolved-challenges"
        },
        "operationId" : "getUnresolvedPersonalChallenges",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "include_categories",
          "in" : "query",
          "description" : "A list of categories that should be included in the response. Only the categories provided will be returned",
          "required" : false,
          "style" : "form",
          "explode" : false,
          "schema" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        }, {
          "name" : "exclude_categories",
          "in" : "query",
          "description" : "A list of categories that should be excluded from the response. All  categories except those listed here will be returned",
          "required" : false,
          "style" : "form",
          "explode" : false,
          "schema" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of ChallengeCategory objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/ChallengeCategory"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/all/{appId}" : {
      "description" : "Use this endpoint to get all challenges including completed challenges. This endpoint is best suited for apps that show a todo like list and want to keep showing completed challenges in the list. If you only want show challenges that the user can do something, use getUnresolvedPersonalChallenges instead.",
      "get" : {
        "tags" : [ "challenges" ],
        "summary" : "Get all personal challenges available for your app. Also includes completed challenges.",
        "description" : "Get personal challenges organized in categories that are not yet finished",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#request-challenges"
        },
        "operationId" : "getAllPersonalChallenges",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "include_categories",
          "in" : "query",
          "description" : "A list of categories that should be included in the response. Only the categories provided will be returned",
          "required" : false,
          "style" : "form",
          "explode" : false,
          "schema" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        }, {
          "name" : "exclude_categories",
          "in" : "query",
          "description" : "A list of categories that should be excluded from the response. All  categories except those listed here will be returned",
          "required" : false,
          "style" : "form",
          "explode" : false,
          "schema" : {
            "type" : "array",
            "items" : {
              "type" : "string"
            }
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of ChallengeCategory objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/ChallengeCategory"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/get/{appId}/{challengeId}" : {
      "description" : "Use this endpoint to load a challenge by id. This will be personalized for the user encoded in the access token.",
      "get" : {
        "tags" : [ "challenges" ],
        "summary" : "Get personal challenge by id",
        "description" : "Get personal challenges organized in categories",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#request-challenges"
        },
        "operationId" : "getPersonalChallengeById",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "challengeId",
          "in" : "path",
          "description" : "The challenge id (see challenge_id of Challenge object)",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A challenge object",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Challenge"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/get-in-progress-challenges/{appId}" : {
      "description" : "Use this endpoint to get all active challenges for your product. This will be personalized for the user encoded in the access token.",
      "get" : {
        "tags" : [ "challenges" ],
        "summary" : "Get active personal challenges",
        "description" : "Get active personal challenges organized in categories",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#get-all-active-challenges"
        },
        "operationId" : "getActivePersonalChallenges",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of ChallengeCategory objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/ChallengeCategory"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/unlock/{appId}/{challengeId}" : {
      "description" : "Challenges are locked by default and don't track any progress. Buy (i.e. unlock or activate) a challenge using this REST-API endpoint.",
      "post" : {
        "tags" : [ "challenges" ],
        "summary" : "Unlock a personal challenges",
        "description" : "Unlock a personal challenge by product id and challenge id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#unlock-a-challenge"
        },
        "operationId" : "unlockPersonalChallenge",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "challengeId",
          "in" : "path",
          "description" : "The challenge id (see challenge_id of Challenge object)",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "201" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/activate/{appId}/{challengeId}" : {
      "description" : "Challenges must be activated before they will track progress. Please note, that this endpoint requires the user_challenge_id set as the second paramater.",
      "put" : {
        "tags" : [ "challenges" ],
        "summary" : "Activate a personal challenges",
        "description" : "Activate a personal challenge by product id and user challenge id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#activate-a-challenge"
        },
        "operationId" : "activatePersonalChallenge",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "challengeId",
          "in" : "path",
          "description" : "The challenge id (see challenge_id of Challenge object)",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/cancel/{appId}/{challengeId}" : {
      "description" : "Challenges can be canceled at any time. Use this endpoint to cancel a challenge.",
      "put" : {
        "tags" : [ "challenges" ],
        "summary" : "Cancel an active personal challenges",
        "description" : "Cancel an active personal challenge by product id and user challenge id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#cancel-a-challenge"
        },
        "operationId" : "cancelPersonalChallenge",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "challengeId",
          "in" : "path",
          "description" : "The challenge id (see challenge_id of Challenge object)",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/personal/claim/{appId}/{challengeId}" : {
      "description" : "Completed challenges must be claimed to finish them. Either you do that automatically (for the user) or you offer a user interface for the user to claim the challenge. Only challenges where type is unclaimed can be claimed. Otherwise this request will fail.",
      "put" : {
        "tags" : [ "challenges" ],
        "summary" : "Claim the reward of a finished personal challenge",
        "description" : "Claim the reward of a finished personal challenge by product id and user challenge id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#claim-a-reward"
        },
        "operationId" : "claimPersonalChallengeReward",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "challengeId",
          "in" : "path",
          "description" : "The challenge id (see challenge_id of Challenge object)",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/challenges/web-socket/generate-token" : {
      "description" : "Request an access token for the Websockets server, then you connect to the Websocket server to receive updates in realtime.",
      "get" : {
        "tags" : [ "challenges" ],
        "summary" : "Get an access token for the Websockets server notifying of updates in real time",
        "description" : "Get an access token for the Websockets server notifying of updates in real time",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/challenges/#1-get-a-topic"
        },
        "operationId" : "generateWebsocketAccessToken",
        "responses" : {
          "200" : {
            "description" : "Returns the socket token",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/SocketToken"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "deprecated" : true,
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/reset-challenges/{appId}/{userId}" : {
      "description" : "Resets all challenges for a given user",
      "post" : {
        "tags" : [ "challenges" ],
        "summary" : "Resets all challenges for the given app ID and user ID",
        "description" : "Resets all challenges for the given app ID and user ID",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/realtimeupdates/"
        },
        "operationId" : "resetUserAppChallenges",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "userId",
          "in" : "path",
          "description" : "The user id (",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://pcs.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://pcs-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://pcs-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-passes/{appId}" : {
      "description" : "Using this endpoint you can query all available Battle Passes for the given product id. Typically this query is used to show Battle Passes the user can purchase. You can use the package_sku field to trigger the corresponding in-app purchase.",
      "get" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Get battle passes",
        "description" : "Get battle passes for the product",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#retrieve-available-bps"
        },
        "operationId" : "getBattlePasses",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of BattlePass objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/BattlePass"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-passes/{appId}/active" : {
      "description" : "Using this endpoint you can query all active available Battle Passes for the given app id. Typically this query is used to show Battle Passes the user can purchase. You can use the package_sku field to trigger the corresponding in-app purchase.",
      "get" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Get battle passes",
        "description" : "Get active battle passes for the app",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#retrieve-available-bps"
        },
        "operationId" : "getActiveBattlePasses",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of BattlePass objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/BattlePass"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-passes/{appId}/unlocked" : {
      "description" : "Using this endpoint you can query all Battle Passes unlocked for the user.",
      "get" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Get battle passes unlocked by the user",
        "description" : "Get unlocked battle passes for the user encoded in the access token",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#retrieve-available-bps"
        },
        "operationId" : "getUnlockedBattlePasses",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of BattlePass objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/BattlePass"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-passes/{appId}/single/{battlePassId}" : {
      "description" : "Use this endpoint to retrieve a specific battle pass. By using the access token this object is enriched with user specific additions and current status.",
      "get" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Get battle pass by id",
        "description" : "Get battle pass for the product with id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#retrieve-available-bps"
        },
        "operationId" : "getBattlePass",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "battlePassId",
          "in" : "path",
          "description" : "The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A BattlePass object",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/BattlePass"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-pass-levels/{appId}/{battlePassId}" : {
      "description" : "Use this endpoint to retrieve the levels of a specific battle pass.",
      "get" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Get battle pass levels for a battle pass",
        "description" : "Get battle pass levels for a battle pass",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses#retrieve-available-bps"
        },
        "operationId" : "getBattlePassLevels",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "battlePassId",
          "in" : "path",
          "description" : "The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of BattlePassLevel objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/BattlePassLevel"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-pass-levels/{appId}" : {
      "description" : "Get all battle pass levels for the app",
      "get" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Get battle pass levels for an app (from all battle passes)",
        "description" : "Get all battle pass levels for an app",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#retrieve-battle-pass"
        },
        "operationId" : "getAllBattlePassLevels",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of BattlePassLevel objects",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/BattlePassLevel"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-pass-levels/{appId}/activate/{levelId}" : {
      "description" : "Use this endpoint to activate a battle pass level by level id",
      "post" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Activate a given battle pass level by id",
        "description" : "Activate a given battle pass level by id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#activate-level"
        },
        "operationId" : "activateBattlePassLevel",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "levelId",
          "in" : "path",
          "description" : "The id of the battle pass level.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-pass-levels/{appId}/claim/{levelId}" : {
      "description" : "Use this endpoint to claim a battle pass level reward by level id",
      "post" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Claim the battle pass level reward. This will trigger a Webhook that you can use to unlock the reward on server side. If you don't have a server you can also unlock in the client application after receiving a positive response.",
        "description" : "Claim the battle pass level id",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/#activate-level"
        },
        "operationId" : "claimBattlePassLevelReward",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "levelId",
          "in" : "path",
          "description" : "The id of the battle pass level.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v2/leaderboards/{leaderboardId}" : {
      "description" : "Get the current leaderboard by id",
      "get" : {
        "tags" : [ "leaderboardsV2" ],
        "summary" : "Retrieve Leaderboard",
        "description" : "Provides the selected leaderboard V2 rankings for a specific leaderboard.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/leaderboards/#retrieve-leaderboard"
        },
        "operationId" : "getLeaderboardV2",
        "parameters" : [ {
          "name" : "leaderboardId",
          "in" : "path",
          "description" : "The id of the leaderboard",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "aggregate",
          "in" : "query",
          "description" : "The aggregate function for the calculation of the results - can be BEST (returns a single score - either the lowest if ASC sorting is used, or the highest if DESC is used) or SUM (default value - increments (sums up) the scores).",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "example" : "BEST"
          }
        }, {
          "name" : "currentPage",
          "in" : "query",
          "description" : "The page index starting at 1. The number of pageSize elements are returned for each page. Default value is 1",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "currentPosition",
          "in" : "query",
          "description" : "The starting leaderboard position from which the results should be loaded. The number of results is controlled via the pageSize variable. This parameter overrides the currentPage parameter.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "The number of elements per page. Default is 25.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A Leaderboard object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/LeaderboardV2Results"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ls.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ls-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ls-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v2/leaderboards" : {
      "description" : "Get all leaderboard results",
      "get" : {
        "tags" : [ "leaderboardsV2" ],
        "summary" : "Retrieve Leaderboards",
        "description" : "Returns an array of LeaderboardV2Results items defined for the application.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/leaderboards/#retrieve-leaderboards"
        },
        "operationId" : "getLeaderboardsV2",
        "parameters" : [ {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "aggregate",
          "in" : "query",
          "description" : "The aggregate function for the calculation of the results - can be BEST (returns a single score - either the lowest if ASC sorting is used, or the highest if DESC is used) or SUM (default value - increments (sums up) the scores).",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "example" : "BEST"
          }
        }, {
          "name" : "currentPage",
          "in" : "query",
          "description" : "The page index starting at 1. The number of pageSize elements are returned for each page. Default value is 1",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "currentPosition",
          "in" : "query",
          "description" : "The starting leaderboard position from which the results should be loaded. The number of results is controlled via the pageSize variable. This parameter overrides the currentPage parameter.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "The number of elements per page. Default is 25.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A Leaderboard object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/LeaderboardV2Results"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ls.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ls-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ls-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v2/leaderboards-members/{memberType}/{memberId}" : {
      "description" : "Get the rankings for a specified user for all leaderboards V2 defined in the application",
      "get" : {
        "tags" : [ "leaderboardsV2" ],
        "summary" : "Retrieve user rankings across all leaderboards",
        "description" : "Returns an array of LeaderboardV2MemberRanking items defined for all leaderboards in the application specified for the user. If the member is not in the leaderboard, the rank will be -1 in the LeaderboardRanking object.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/leaderboards/#retrieve-user-rankings"
        },
        "operationId" : "getLeaderboardV2Rankings",
        "parameters" : [ {
          "name" : "memberType",
          "in" : "path",
          "description" : "The member type, can be user or team (right now) and sets which leaderboards should be selected.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "memberId",
          "in" : "path",
          "description" : "Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "aggregate",
          "in" : "query",
          "description" : "The aggregate function for the calculation of the results - can be BEST (returns a single score - either the lowest if ASC sorting is used, or the highest if DESC is used) or SUM (default value - increments (sums up) the scores).",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "example" : "BEST"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "An array of LeaderboardV2MemberRanking objects with information about all the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/LeaderboardV2MemberRanking"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ls.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ls-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ls-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v2/leaderboards-members/{memberType}/{memberId}/{leaderboardId}" : {
      "description" : "Get the rankings for a specified user and the specified leaderboard V2 defined in the application. If the member is not in the leaderboard, the rank will be -1 in the LeaderboardRanking object.",
      "get" : {
        "tags" : [ "leaderboardsV2" ],
        "summary" : "Retrieve user ranking for a single leaderboard V2",
        "description" : "Returns a LeaderboardV2MemberRanking item for the specified leaderboard. Use this route to get the position of a user of team in a specified leaderboard.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/leaderboards/#retrieve-user-rankings"
        },
        "operationId" : "getLeaderboardV2Ranking",
        "parameters" : [ {
          "name" : "memberType",
          "in" : "path",
          "description" : "The member type, can be user or team (right now) and sets which leaderboards should be selected.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "memberId",
          "in" : "path",
          "description" : "Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "leaderboardId",
          "in" : "path",
          "description" : "The id of the leaderboard",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "aggregate",
          "in" : "query",
          "description" : "The aggregate function for the calculation of the results - can be BEST (returns a single score - either the lowest if ASC sorting is used, or the highest if DESC is used) or SUM (default value - increments (sums up) the scores).",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "example" : "BEST"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A LeaderboardMemberRankings object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/LeaderboardV2MemberRanking"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ls.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ls-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ls-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v2/leaderboards-reset/{appId}/{leaderboardId}" : {
      "description" : "Deletes all leaderboard V2 data, i.e. reset the leaderboard V2.",
      "delete" : {
        "tags" : [ "leaderboardsV2" ],
        "summary" : "Reset user leaderboard data",
        "description" : "Deletes all leaderboard V2 data, i.e. reset the leaderboard V2.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/leaderboards/#reset-leaderboard-data"
        },
        "operationId" : "resetLeaderboardV2Rankings",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The application ID",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "leaderboardId",
          "in" : "path",
          "description" : "The leaderboard ID",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ls.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ls-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ls-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/battle-passes/{appId}/unlock/{battlePassId}" : {
      "description" : "Unlock the specified battle pass for the user provided in the access token. You can provide purchase info like price and currency.",
      "post" : {
        "tags" : [ "battle-passes" ],
        "summary" : "Unlock the battle pass for the user specified in the access token",
        "description" : "Unlock the battle pass for a user",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/battlepasses/"
        },
        "operationId" : "unlockBattlePass",
        "parameters" : [ {
          "name" : "appId",
          "in" : "path",
          "description" : "The app id",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "battlePassId",
          "in" : "path",
          "description" : "The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "requestBody" : {
          "description" : "Provide purchase info for the battle pass",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/BattlePassUnlockPayload"
              }
            }
          },
          "required" : false
        },
        "responses" : {
          "200" : {
            "description" : "Returns unlock info about a battle pass",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/BattlePassUnlockInfo"
                }
              }
            }
          },
          "402" : {
            "description" : "This request could not be performed. Most of the time this happens if the action already has been executed before.",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://es.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://es-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://es-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    },
    "/api/v1/leaderboards/{leaderboardId}" : {
      "description" : "Get current leaderboard specific by id",
      "get" : {
        "tags" : [ "leaderboards" ],
        "summary" : "Retrieve Leaderboard",
        "description" : "Provides the current leaderboard rankings for a specific leaderboard.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.scillgame.com/api/leaderboards.html"
        },
        "operationId" : "getLeaderboard",
        "parameters" : [ {
          "name" : "leaderboardId",
          "in" : "path",
          "description" : "The id of the leaderboard",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "currentPage",
          "in" : "query",
          "description" : "The page index starting at 1. The number of pageSize elements are returned for each page. Default value is 1",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "The number of elements per page. Default is 25.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A Leaderboard object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Leaderboard"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      }
    },
    "/api/v1/leaderboards" : {
      "description" : "Get all leaderboards",
      "get" : {
        "tags" : [ "leaderboards" ],
        "summary" : "Retrieve Leaderboards",
        "description" : "Returns an array of Leaderboard items defined for the application.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.scillgame.com/api/leaderboards.html"
        },
        "operationId" : "getLeaderboards",
        "parameters" : [ {
          "name" : "currentPage",
          "in" : "query",
          "description" : "The page index starting at 1. The number of pageSize elements are returned for each page. Default value is 1",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "pageSize",
          "in" : "query",
          "description" : "The number of elements per page. Default is 25.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A Leaderboard object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/Leaderboard"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      }
    },
    "/api/v1/leaderboards-members/{memberType}/{memberId}" : {
      "description" : "Get the rankings for a specified user for all leaderboards defined in the application",
      "get" : {
        "tags" : [ "leaderboards" ],
        "summary" : "Retrieve User Rankings",
        "description" : "Returns an array of LeaderboardRanking items defined for all leaderboards in the application specified for the user. If the member is not in the leaderboard, the rank will be -1 in the LeaderboardRanking object.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.scillgame.com/api/leaderboards.html"
        },
        "operationId" : "getLeaderboardRankings",
        "parameters" : [ {
          "name" : "memberType",
          "in" : "path",
          "description" : "The member type, can be user or team (right now) and sets which leaderboards should be selected.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "memberId",
          "in" : "path",
          "description" : "Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A Leaderboard object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/LeaderboardMemberRanking"
                  }
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      }
    },
    "/api/v1/leaderboards-members/{memberType}/{memberId}/{leaderboardId}" : {
      "description" : "Get the rankings for a specified user and the specified leaderboard defined in the application. If the member is not in the leaderboard, the rank will be -1 in the LeaderboardRanking object.",
      "get" : {
        "tags" : [ "leaderboards" ],
        "summary" : "Retrieve User Ranking",
        "description" : "Returns a LeaderboardMemberRanking item for the specified leaderboard. Use this route to get the position of a user of team in a specified leaderboard.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.scillgame.com/api/leaderboards.html"
        },
        "operationId" : "getLeaderboardRanking",
        "parameters" : [ {
          "name" : "memberType",
          "in" : "path",
          "description" : "The member type, can be user or team (right now) and sets which leaderboards should be selected.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "memberId",
          "in" : "path",
          "description" : "Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "leaderboardId",
          "in" : "path",
          "description" : "The id of the leaderboard",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "startDate",
          "in" : "query",
          "description" : "The starting date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "endDate",
          "in" : "query",
          "description" : "The ending date for fetching results.",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          }
        }, {
          "name" : "language",
          "in" : "query",
          "description" : "Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, ...",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "A Leaderboard object with information about the leaderboard and current rankings",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/LeaderboardMemberRanking"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      }
    },
    "/api/v1/reset-leaderboard/{memberType}/{appId}/{memberId}" : {
      "description" : "Delete all leaderboard data, i.e. reset the leaderboard for the specified member.",
      "delete" : {
        "tags" : [ "leaderboards" ],
        "summary" : "Reset user leaderboard data",
        "description" : "Delete all leaderboard data, i.e. reset the leaderboard for the specified member.",
        "externalDocs" : {
          "description" : "SCILL API Reference",
          "url" : "https://developers.4players.io/scill/api/leaderboards/#reset-leaderboard-data"
        },
        "operationId" : "resetLeaderboardRankings",
        "parameters" : [ {
          "name" : "memberType",
          "in" : "path",
          "description" : "The member type, can be user or team (right now) and sets which leaderboards should be selected.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "appId",
          "in" : "path",
          "description" : "The application ID",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "memberId",
          "in" : "path",
          "description" : "Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "The action has been successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ActionResponse"
                }
              }
            }
          },
          "403" : {
            "description" : "Unauthorized",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          },
          "404" : {
            "description" : "The specified resource was not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security" : [ {
          "BearerAuth" : [ ]
        }, {
          "oAuthNoScopes" : [ ]
        } ]
      },
      "servers" : [ {
        "url" : "https://ls.scillgame.com",
        "description" : "Production URL"
      }, {
        "url" : "https://ls-staging.scillgame.com",
        "description" : "Staging URL"
      }, {
        "url" : "https://ls-dev.scillgame.com",
        "description" : "Dev URL"
      } ]
    }
  },
  "components" : {
    "schemas" : {
      "UserInfo" : {
        "type" : "object",
        "properties" : {
          "username" : {
            "type" : "string",
            "description" : "The user name of the user",
            "nullable" : true,
            "example" : "NoName"
          },
          "avatarImage" : {
            "type" : "string",
            "description" : "The name or URL of an avatar image for a user.",
            "nullable" : true,
            "example" : "https://www.example.com/avatars/unknown.png"
          }
        },
        "description" : "Can be any object that is attached to the user. You can set these values in the user service. For example you can provide a user name and an avatar image url.",
        "nullable" : true
      },
      "Leaderboard" : {
        "type" : "object",
        "properties" : {
          "leaderboard_id" : {
            "type" : "string",
            "description" : "The id of the leaderboard",
            "example" : "641184035742547979"
          },
          "name" : {
            "type" : "string",
            "description" : "The name of the leaderboard",
            "example" : "Hall of Fame"
          },
          "grouped_by_users" : {
            "type" : "array",
            "description" : "An array of LeaderboardRanking Items for individual users",
            "items" : {
              "$ref" : "#/components/schemas/LeaderboardRanking"
            }
          },
          "grouped_by_teams" : {
            "type" : "array",
            "description" : "An array of LeaderboardRanking Items for teams. Provide a team_id in the event payload to also create leaderboards for teams",
            "items" : {
              "$ref" : "#/components/schemas/LeaderboardRanking"
            }
          },
          "num_teams" : {
            "type" : "number",
            "description" : "The total number of team rankings available in the leaderboard",
            "example" : 20482
          },
          "num_users" : {
            "type" : "number",
            "description" : "The total number of user rankings available in the leaderboard",
            "example" : 137299
          }
        },
        "description" : "The Leaderboard object contains information about the leaderboard itself like the name and the id, but also contains actual rankings for users and teams."
      },
      "LeaderboardInfo" : {
        "type" : "object",
        "properties" : {
          "app_id" : {
            "type" : "string",
            "description" : "The id of the app",
            "example" : "597737952688570369"
          },
          "leaderboard_id" : {
            "type" : "string",
            "description" : "The id of the leaderboard",
            "example" : "641184035742547979"
          },
          "name" : {
            "type" : "string",
            "description" : "The name of the leaderboard",
            "example" : "Hall of Fame"
          },
          "event_type" : {
            "type" : "string",
            "description" : "The event type that triggers this leaderboard",
            "example" : "finish-round"
          },
          "sort_order_ascending" : {
            "type" : "boolean",
            "description" : "True if this leaderboard sorts the score ascending or false if the ranking is defined by a descending score.",
            "example" : true
          }
        },
        "description" : "The Leaderboard object contains information about the leaderboard itself like the name and the id"
      },
      "LeaderboardMemberRanking" : {
        "type" : "object",
        "properties" : {
          "leaderboard_id" : {
            "type" : "string",
            "description" : "The id of the leaderboard",
            "example" : "641184035742547979"
          },
          "name" : {
            "type" : "string",
            "description" : "The name of the leaderboard",
            "example" : "Hall of Fame"
          },
          "member" : {
            "$ref" : "#/components/schemas/LeaderboardRanking"
          }
        },
        "description" : "You get these object if you query the leaderboard ranking for a specific user. Only the requested user will be returned."
      },
      "LeaderboardRanking" : {
        "type" : "object",
        "properties" : {
          "member_id" : {
            "type" : "string",
            "description" : "The id of the user - its the same user id you used to create the access token and the same user id you used to send the events",
            "example" : "1234567"
          },
          "member_type" : {
            "type" : "string",
            "description" : "Indicates what type this entry is, it's either user or team",
            "example" : "user"
          },
          "score" : {
            "type" : "integer",
            "description" : "The score achieved as an integer value. If you want to store floats, for example laptimes you need to convert them into an int before (i.e. multiply by 100 to get hundreds of seconds and format back to float in UI)",
            "example" : 3843
          },
          "rank" : {
            "type" : "integer",
            "description" : "The position within the leaderboard",
            "example" : 3
          },
          "additional_info" : {
            "$ref" : "#/components/schemas/UserInfo"
          }
        },
        "description" : "The ranking for the user or team in the leaderboard"
      },
      "LeaderboardScore" : {
        "type" : "object",
        "properties" : {
          "score" : {
            "type" : "integer",
            "description" : "The score achieved as an integer value. If you want to store floats, for example laptimes you need to convert them into an int before (i.e. multiply by 100 to get hundreds of seconds and format back to float in UI)",
            "example" : 3843
          },
          "rank" : {
            "type" : "integer",
            "description" : "The position within the leaderboard",
            "example" : 3
          }
        },
        "description" : "Contains info about rank and score"
      },
      "LeaderboardUpdatePayload" : {
        "type" : "object",
        "properties" : {
          "webhook_type" : {
            "type" : "string",
            "description" : "The type of the webhook, in this case it is leaderboard-ranking-changed",
            "example" : "leaderboard-ranking-changed"
          },
          "leaderboard_data" : {
            "$ref" : "#/components/schemas/LeaderboardInfo"
          },
          "member_data" : {
            "$ref" : "#/components/schemas/LeaderboardRanking"
          },
          "old_leaderboard_ranking" : {
            "$ref" : "#/components/schemas/LeaderboardScore"
          },
          "new_leaderboard_ranking" : {
            "$ref" : "#/components/schemas/LeaderboardScore"
          }
        },
        "description" : "The payload used for realtime updates and webhooks if a leaderboard is updated."
      },
      "LeaderboardV2Results" : {
        "type" : "object",
        "properties" : {
          "leaderboard_id" : {
            "type" : "string",
            "description" : "The id of the leaderboard",
            "example" : "641184035742547979"
          },
          "leaderboard_name" : {
            "type" : "string",
            "description" : "The name of the leaderboard",
            "example" : "Hall of Fame"
          },
          "leaderboard_sort_order_ascending" : {
            "type" : "boolean",
            "description" : "Determines the results sort order. If true, the order is ascending, otherwise, it's descending.",
            "example" : true
          },
          "leaderboard_results_by_member_type" : {
            "$ref" : "#/components/schemas/LeaderboardV2Results_leaderboard_results_by_member_type"
          }
        },
        "description" : "The Leaderboard object contains information about the leaderboard itself like the name and the id, but also contains actual rankings for users and teams."
      },
      "LeaderboardV2Info" : {
        "type" : "object",
        "properties" : {
          "app_id" : {
            "type" : "string",
            "description" : "The id of the app",
            "example" : "597737952688570369"
          },
          "leaderboard_id" : {
            "type" : "string",
            "description" : "The id of the leaderboard",
            "example" : "641184035742547979"
          },
          "leaderboard_name" : {
            "type" : "string",
            "description" : "The name of the leaderboard",
            "example" : "Hall of Fame"
          },
          "event_type" : {
            "type" : "string",
            "description" : "The event type that triggers this leaderboard",
            "example" : "finish-round"
          },
          "sort_order_ascending" : {
            "type" : "boolean",
            "description" : "True if this leaderboard sorts the score ascending or false if the ranking is defined by a descending score.",
            "example" : true
          }
        },
        "description" : "The Leaderboard object contains information about the leaderboard itself like the name and the id"
      },
      "LeaderboardV2Changed" : {
        "type" : "object",
        "properties" : {
          "webhook_type" : {
            "type" : "string",
            "description" : "The type of the notification. If you receive this payload, it's most likely leaderboard-changed.",
            "example" : "laderboard-info"
          },
          "old_leaderboard" : {
            "$ref" : "#/components/schemas/LeaderboardV2Info"
          },
          "new_leaderboard" : {
            "$ref" : "#/components/schemas/LeaderboardV2Info"
          }
        },
        "description" : "This object is sent via Webhook or notifications of type leaderboard-changed."
      },
      "LeaderboardV2MemberRanking" : {
        "type" : "object",
        "properties" : {
          "leaderboard_id" : {
            "type" : "string",
            "description" : "The id of the leaderboard",
            "example" : "641184035742547979"
          },
          "leaderboard_name" : {
            "type" : "string",
            "description" : "The name of the leaderboard",
            "example" : "Hall of Fame"
          },
          "leaderboard_sort_order_ascending" : {
            "type" : "boolean",
            "description" : "Determines the results sort order. If true, the order is ascending, otherwise, it's descending.",
            "example" : true
          },
          "leaderboard_member" : {
            "$ref" : "#/components/schemas/LeaderboardV2Member"
          }
        },
        "description" : "The Leaderboard object contains information about the leaderboard itself like the name and the id"
      },
      "LeaderboardV2MemberTypeRanking" : {
        "type" : "object",
        "properties" : {
          "count" : {
            "type" : "integer",
            "description" : "The total number of members included in the results",
            "example" : 123
          },
          "members" : {
            "type" : "array",
            "description" : "An array of LeaderboardMember objects",
            "items" : {
              "$ref" : "#/components/schemas/LeaderboardV2Member"
            }
          }
        },
        "description" : "You get this object if you query the leaderboard ranking for a specific user. Only the requested user will be returned."
      },
      "LeaderboardV2Member" : {
        "type" : "object",
        "properties" : {
          "member_id" : {
            "type" : "string",
            "description" : "The id of the user - its the same user id you used to create the access token and the same user id you used to send the events",
            "example" : "1234567"
          },
          "member_type" : {
            "type" : "string",
            "description" : "Indicates what type this entry is, it's either user or team",
            "example" : "user"
          },
          "score" : {
            "type" : "integer",
            "description" : "The score achieved as an integer value. If you want to store floats, for example laptimes you need to convert them into an int before (i.e. multiply by 100 to get hundreds of seconds and format back to float in UI)",
            "example" : 3843
          },
          "rank" : {
            "type" : "integer",
            "description" : "The position within the leaderboard",
            "example" : 3
          },
          "metadata_results" : {
            "type" : "array",
            "description" : "Returns an array of the LeaderboardMemberMetadata objects containing user ranking metadata information",
            "items" : {
              "$ref" : "#/components/schemas/LeaderboardV2MemberMetadata"
            }
          },
          "additional_info" : {
            "$ref" : "#/components/schemas/UserInfo"
          }
        },
        "description" : "The ranking for the user or team in the leaderboard"
      },
      "LeaderboardV2MemberMetadata" : {
        "type" : "object",
        "properties" : {
          "key" : {
            "type" : "string",
            "description" : "The event type key used for ranking",
            "example" : "required_time"
          },
          "ranked" : {
            "type" : "boolean",
            "description" : "Determines if the user is ranked for that event type key. If false, no score and rank will be provided"
          },
          "score" : {
            "type" : "integer",
            "description" : "The score achieved as an integer value. If you want to store floats, for example laptimes you need to convert them into an int before (i.e. multiply by 100 to get hundreds of seconds and format back to float in UI)",
            "example" : 3843
          },
          "rank" : {
            "type" : "integer",
            "description" : "The position within the leaderboard",
            "example" : 3
          }
        },
        "description" : "The object containing secondary metadata ranking information, useful for tied scores on the main tracking parameter"
      },
      "LeaderboardV2UpdatePayload" : {
        "type" : "object",
        "properties" : {
          "webhook_type" : {
            "type" : "string",
            "description" : "The type of the webhook, in this case it is leaderboard-ranking-changed",
            "example" : "leaderboard-ranking-changed"
          },
          "leaderboard_data" : {
            "$ref" : "#/components/schemas/LeaderboardV2Info"
          },
          "member_data" : {
            "$ref" : "#/components/schemas/LeaderboardV2Member"
          },
          "old_leaderboard_ranking" : {
            "$ref" : "#/components/schemas/LeaderboardScore"
          },
          "new_leaderboard_ranking" : {
            "$ref" : "#/components/schemas/LeaderboardScore"
          }
        },
        "description" : "The payload used for realtime updates and webhooks if a leaderboard is updated."
      },
      "ActionResponse" : {
        "required" : [ "message", "status" ],
        "type" : "object",
        "properties" : {
          "status" : {
            "type" : "integer",
            "description" : "HTTP status code",
            "example" : 200
          },
          "message" : {
            "type" : "string",
            "example" : "OK"
          },
          "challenge" : {
            "$ref" : "#/components/schemas/Challenge"
          }
        },
        "description" : "Standard response for actions like update or delete. If anything went fine, you'll receive a HTTP code of 200 and a OK message."
      },
      "Challenge" : {
        "type" : "object",
        "properties" : {
          "challenge_id" : {
            "type" : "string",
            "description" : "The unique id of this challenge. Every challenge is linked to a product.",
            "example" : "505538946732425217"
          },
          "challenge_name" : {
            "type" : "string",
            "description" : "The name of the challenge in the language set by the language parameter.",
            "example" : "Survive 3 battles"
          },
          "challenge_description" : {
            "type" : "string",
            "description" : "An optional multi-language description that can be set in the Admin Panel. Used to describe exactly what the user has to do.",
            "example" : "Get a great reward by managing this challenge. You can try as long as you like"
          },
          "challenge_duration_time" : {
            "type" : "number",
            "description" : "The duration of the challenge in seconds. Challenges auto lock after time-out and need to be unlocked again.",
            "example" : 500
          },
          "live_date" : {
            "type" : "string",
            "description" : "The date this challenge should start. Use that field to create challenges that start in the future.",
            "example" : "2020-10-12T00:00:00Z"
          },
          "challenge_goal" : {
            "type" : "integer",
            "description" : "Indicates how many “tasks” must be completed or done to complete this challenge.",
            "example" : 5
          },
          "user_challenge_current_score" : {
            "type" : "integer",
            "description" : "Indicates how many tasks the user already has completed. Use this in combination with challenge_goal to render a nice progress bar.",
            "example" : 0
          },
          "challenge_icon" : {
            "type" : "string",
            "description" : "In the admin panel you can set a string representing an image. This can be a URL, but it can also be an image or texture that you have in your games asset database.",
            "example" : "black-arrow"
          },
          "challenge_icon_hd" : {
            "type" : "string",
            "description" : "This is the HD variant of the challenge icon image. If you have a game, that runs on multiple platforms that could come in handy. Otherwise just leave blank.",
            "example" : "black-arrow-hd"
          },
          "challenge_price" : {
            "type" : "integer",
            "description" : "If you purchase the challenge, you can set a price.",
            "example" : 0
          },
          "challenge_reward" : {
            "type" : "string",
            "description" : "Set a reward for this challenge. This is a string value that you can map to anything in your code. Use in combination with challenge_reward_type.",
            "example" : "weapon_a"
          },
          "challenge_reward_type" : {
            "type" : "string",
            "description" : "The reward type can be set to various different settings. Use it to implement different reward types on your side and use challenge_reward to set the value or amount of this reward.",
            "example" : "item"
          },
          "challenge_goal_condition" : {
            "type" : "integer",
            "description" : "With this you can set the way how the SCILL system approaches the challenges state. 0 means, that the counter of the challenge must be brought above the goal. If this is 1, then the counter must be kept below the goal. This is often useful for challenges that include times, like: Manage the level in under 50 seconds.",
            "example" : 0
          },
          "challenge_xp" : {
            "type" : "integer",
            "description" : "If you have experience, player rankings whatever, you can use this field to set the gain in that when this challenge is rewarded.",
            "example" : 0
          },
          "repeatable" : {
            "type" : "boolean",
            "description" : "If this challenge can be only activated once per user this will be false. Otherwise this challenge will always be added to list of available challenges (see personal or alliance challenges).",
            "example" : false
          },
          "type" : {
            "type" : "string",
            "description" : "Indicates the status of the challenge. This can be one of the following unlock: Challenge does not track anything. in-progress: Challenge is active and tracking. overtime: User did not manage to finish the challenge in time. unclaimed: The challenge has been completed but the reward has not yet been claimed. finished: The challenge has been successfully be completed and the reward has been claimed",
            "example" : "unlock"
          },
          "challenge_auto_activated" : {
            "type" : "boolean",
            "description" : "Indicates if the challenges lifecycle is handled automatically by the SCILL backend. Use this flag to decide when to show action buttons for unlocking, activating, claiming or canceling challenges. Hide the buttons if this flag is true, and let the user manage challenges manually if this flag is false.",
            "example" : true
          },
          "is_claimed" : {
            "type" : "boolean",
            "description" : "If the challenge reward has been claimed this is true otherwise its false.",
            "example" : false
          },
          "user_challenge_unlocked_at" : {
            "type" : "string",
            "description" : "This is the timestamp the challenge has been unlocked.",
            "format" : "datestring",
            "nullable" : true,
            "example" : "null"
          },
          "user_challenge_activated_at" : {
            "type" : "string",
            "description" : "This is the timestamp the challenge has been activated.",
            "format" : "datestring",
            "nullable" : true,
            "example" : "null"
          },
          "user_challenge_is_claimed" : {
            "type" : "boolean",
            "description" : "Indicates if this challenge has been claimed.",
            "example" : false
          },
          "user_challenge_status" : {
            "type" : "integer",
            "description" : "Gives indication in what state the challenge is.",
            "example" : 0
          }
        },
        "description" : "The challenge object holds all information about a users challenge. It contains information like the duration, the type, progress states like counter and the goal and various other info."
      },
      "ChallengeCategory" : {
        "type" : "object",
        "properties" : {
          "is_daily_category" : {
            "type" : "boolean",
            "description" : "Indicates if this is the daily category, bringing up new challenges every day for the user to tackle.",
            "example" : false
          },
          "category_position" : {
            "type" : "integer",
            "description" : "In the admin panel you set the order of the categories. This is the position index and indicates the position within the categories array.",
            "example" : 0
          },
          "category_slug" : {
            "type" : "string",
            "description" : "A short name without special chars to make it easier to refer to a specific category (in code) that is language and id agnostic.",
            "example" : "beginner-challenges"
          },
          "category_name" : {
            "type" : "string",
            "description" : "The name of the category in the local language set as the query parameter.",
            "example" : "Beginner challenges"
          },
          "category_id" : {
            "type" : "string",
            "description" : "Indicates how many “tasks” must be completed or done to complete this challenge.",
            "example" : "543133912041586700"
          },
          "challenges" : {
            "type" : "array",
            "description" : "An array of Challenge objects.",
            "items" : {
              "$ref" : "#/components/schemas/Challenge"
            }
          }
        },
        "description" : "Challenges are grouped into categories. You can exclude or include categories in queries. Per default all categories will be returned."
      },
      "BattlePass" : {
        "type" : "object",
        "properties" : {
          "battle_pass_id" : {
            "type" : "string",
            "description" : "The unique id of this battle pass.",
            "example" : "603693723277918210"
          },
          "app_id" : {
            "type" : "string",
            "description" : "The unique id of the app",
            "example" : "597737952688570369"
          },
          "battle_pass_name" : {
            "type" : "string",
            "description" : "The name of the battle bass. You can set that in the Admin Panel. The language is set with the query parameter language. See documentation for more info on that.",
            "example" : "My Battlepass"
          },
          "battle_pass_description" : {
            "type" : "string",
            "description" : "The description of the battle bass. You can set that in the Admin Panel and it can also be HTML. The language is set with the query parameter language. See documentation for more info on that.",
            "example" : "This battle pass gives you great fun and awesome rewards."
          },
          "battle_pass_short_description" : {
            "type" : "string",
            "description" : "A short description of the battle bass. You can set that in the Admin Panel and it can also be HTML. The language is set with the query parameter language. See documentation for more info on that.",
            "example" : "This battle pass gives you great fun and awesome rewards."
          },
          "battle_pass_disclaimer" : {
            "type" : "string",
            "description" : "Use this to provide some terms and conditions following along this battle passes purchase.",
            "example" : "Use at your own risk"
          },
          "battle_pass_priority" : {
            "type" : "integer",
            "description" : "The priority of the battle pass. I.e. if multiple are available you can use this field to sort them.",
            "example" : 1
          },
          "package_sku_ios" : {
            "type" : "string",
            "description" : "If you want to sell Battle Passes you can use this field to trigger in-app purchase products within your mobile app. You can set this value in the Admin Panel. This one is for iOS.",
            "example" : "com.example.bp.season1"
          },
          "package_sku_android" : {
            "type" : "string",
            "description" : "If you want to sell Battle Passes you can use this field to trigger in-app purchase products within your mobile app. You can set this value in the Admin Panel. Use this to set the package string for Android.",
            "example" : "com.example.bp.season1"
          },
          "image_xs" : {
            "type" : "string",
            "description" : "The xs sized image name or url. You can determine the best size distribution yourself and depends on your application or UI",
            "example" : "season1_xs.png"
          },
          "image_s" : {
            "type" : "string",
            "description" : "The s sized image name or url. You can determine the best size distribution yourself and depends on your application or UI",
            "example" : "season1_s.png"
          },
          "image_m" : {
            "type" : "string",
            "description" : "The m sized image name or url. You can determine the best size distribution yourself and depends on your application or UI",
            "example" : "season1_m.png"
          },
          "image_l" : {
            "type" : "string",
            "description" : "The l sized image name or url. You can determine the best size distribution yourself and depends on your application or UI",
            "example" : "season1_l.png"
          },
          "image_xl" : {
            "type" : "string",
            "description" : "The xl sized image name or url. You can determine the best size distribution yourself and depends on your application or UI",
            "example" : "season1_xl.png"
          },
          "start_date" : {
            "type" : "string",
            "description" : "The date (in iso format) when the Battle Pass starts. Tracking begins once this date is passed.",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          },
          "end_date" : {
            "type" : "string",
            "description" : "The date (in iso format) when the Battle Pass ends. Tracking stops once the end is reached and users will not be able to progress further than what they have achieved up to that point.",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          },
          "read_more_link" : {
            "type" : "string",
            "description" : "If the Battle Pass costs “money” you may want to route the user to a web site/page, where they can learn more about this battle pass. You can also use this field to route the user inside your application by providing a path or whatever works for you.",
            "example" : "https://www.example.com/battle-passes/season1.html"
          },
          "is_unlocked_incrementally" : {
            "type" : "boolean",
            "description" : "Indicates if one level after the other must be activated or if users can activate whichever level they want. Typically battle passes are unlocked level by level, but if battle passes are used for other applications (like user referal programs) it can be useful to set this to false.",
            "example" : true
          },
          "is_active" : {
            "type" : "boolean",
            "description" : "Indicated if this battle pass is active.",
            "example" : false
          },
          "unlocked_at" : {
            "type" : "string",
            "description" : "The date in iso format when the user unlocked this Battle Pass.",
            "format" : "RFC3339",
            "example" : "2020-08-26T08:51:09Z"
          },
          "can_purchase_with_money" : {
            "type" : "boolean",
            "description" : "Indicates that this Battle Pass can be purchased via in-app purchase. This can be set in the Admin Panel.",
            "example" : true
          },
          "can_purchase_with_coins" : {
            "type" : "boolean",
            "description" : "Indicates that this Battle Pass can be purchased with SCILL Coins. This can be set in the Admin Panel.",
            "example" : false
          }
        },
        "description" : "A Battle Pass is a structured layer above challenges and handles the lifecycle of challenges based on a level system. Users need to fullfil challenges to unlock the next level. Each level can have a reward that you can specify in the BattlePassLevel structure. Battle Passes need to be unlocked before they start tracking progress."
      },
      "BattlePassTranslation" : {
        "type" : "object",
        "properties" : {
          "language_id" : {
            "type" : "string",
            "description" : "The id of the language",
            "example" : "594089057856618499"
          },
          "name" : {
            "type" : "string",
            "description" : "The name of the Battle Pass in the local language set in the request (see Setting Language). In the admin panel you can either create HTML content or plain text.",
            "example" : "Season 1"
          },
          "description" : {
            "type" : "string",
            "description" : "The description of the Battle Pass in the local language set in the request (see Setting Language). In the admin panel you can either create HTML content or plain text.",
            "example" : "Get some great items this season."
          },
          "short_description" : {
            "type" : "string",
            "description" : "A short description in the local language you can use to teaser battle passes or implement “expand for more” functionality.",
            "example" : "Get great items"
          },
          "disclaimer" : {
            "type" : "string",
            "description" : "Use this to provide some terms and conditions following along this battle passes purchase.",
            "example" : "Use at your own risk"
          }
        },
        "deprecated" : true
      },
      "BattlePassLevel" : {
        "type" : "object",
        "properties" : {
          "level_id" : {
            "type" : "string",
            "description" : "Unique id of this BattlePassLevel object.",
            "example" : "563006391671062538"
          },
          "app_id" : {
            "type" : "string",
            "description" : "The app id",
            "example" : "597737952688570369"
          },
          "battle_pass_id" : {
            "type" : "string",
            "description" : "The id of the battle pass this level belongs to",
            "example" : "603693723277918210"
          },
          "reward_amount" : {
            "type" : "string",
            "description" : "In the Admin Panel you can set different types of rewards. You can also set an identifier of an in-game-item or anything you like. Use this to include the reward into your own business logic.",
            "example" : "100"
          },
          "reward_type_name" : {
            "type" : "string",
            "description" : "There are different types of rewards available. Possible values are Coins, Voucher, Money and Experience. This is deprecated in favor of level_reward_type which uses a slug instead of a human readable expression",
            "example" : "Coins",
            "deprecated" : true
          },
          "level_reward_type" : {
            "type" : "string",
            "description" : "The reward type in a machine readable slug. Available values are nothing, coin, experience, item",
            "example" : "coins"
          },
          "level_completed" : {
            "type" : "boolean",
            "description" : "Indicates if this level is completed, i.e. all challenges have been completed.",
            "example" : false
          },
          "level_priority" : {
            "type" : "number",
            "description" : "Indicates the position of the level.",
            "example" : 1
          },
          "reward_claimed" : {
            "type" : "boolean",
            "description" : "Indicates if this level has already be claimed.",
            "example" : true
          },
          "activated_at" : {
            "type" : "string",
            "description" : "The date when this level has been activated or null if it's not activated.",
            "example" : "2020-11-26T08:51:09Z"
          },
          "challenges" : {
            "type" : "array",
            "description" : "An array of BattlePassLevelChallenge objects. Please note, not all values are available from the challenge object, as battle passes handle the lifecycle of challenges.",
            "items" : {
              "$ref" : "#/components/schemas/BattlePassLevelChallenge"
            }
          }
        },
        "description" : "Battle Passes are grouped into levels that contain challenges that must be achieved to unlock the next level. Only challenges for the current level are tracking progress."
      },
      "BattlePassLevelChallenge" : {
        "type" : "object",
        "properties" : {
          "challenge_id" : {
            "type" : "string",
            "description" : "The unique id of this challenge. Every challenge is linked to a product.",
            "example" : "505538946732425217"
          },
          "challenge_name" : {
            "type" : "string",
            "description" : "The name of the challenge in the language set by the language parameter.",
            "example" : "Survive 5 battles"
          },
          "challenge_goal" : {
            "type" : "integer",
            "description" : "Indicates how many “tasks” must be completed or done to complete this challenge.",
            "example" : 5
          },
          "challenge_goal_condition" : {
            "type" : "integer",
            "description" : "With this you can set the way how the SCILL system approaches the challenges state. 0 means, that the counter of the challenge must be brought above the goal. If this is 1, then the counter must be kept below the goal. This is often useful for challenges that include times, like: Manage the level in under 50 seconds.",
            "example" : 0
          },
          "user_challenge_current_score" : {
            "type" : "integer",
            "description" : "Indicates how many tasks the user already has completed. Use this in combination with challenge_goal to render a nice progress bar.",
            "example" : 0
          },
          "challenge_xp" : {
            "type" : "integer",
            "description" : "If you have experience, player rankings whatever, you can use this field to set the gain in that when this challenge is rewarded.",
            "example" : 0
          },
          "challenge_icon" : {
            "type" : "string",
            "description" : "In the admin panel you can set a string representing an image. This can be a URL, but it can also be an image or texture that you have in your games asset database.",
            "example" : "black-arrow"
          },
          "challenge_icon_hd" : {
            "type" : "string",
            "description" : "This is the HD variant of the challenge icon image. If you have a game, that runs on multiple platforms that could come in handy. Otherwise just leave blank.",
            "example" : "black-arrow-hd"
          },
          "type" : {
            "type" : "string",
            "description" : "Indicates the status of the challenge. This can be one of the following unlock: Challenge does not track anything. in-progress: Challenge is active and tracking. overtime: User did not manage to finish the challenge in time. unclaimed: The challenge has been completed but the reward has not yet been claimed. finished: The challenge has been successfully be completed and the reward has been claimed",
            "example" : "unlock"
          }
        },
        "description" : "Each level in battle passes contains one or more challenges that need to be fullfilled to unlock the next level. This structure holds challenge information and is based on the Challenge structure. However, as Battle Passes manage the lifecycle of challenges, this data structure is a bit simpler. The same principles apply mostly as for the personal challenges, i.e. you can share the exact same UI to render personal challenges and battle pass challenges."
      },
      "BattlePassLevelId" : {
        "required" : [ "battle_pass_level_id" ],
        "type" : "object",
        "properties" : {
          "battle_pass_level_id" : {
            "type" : "string",
            "description" : "The level id, i.e. battle_pass_level_id of the BattlePassLevel object",
            "example" : "563006391554179082"
          }
        },
        "description" : "Used in previous versions of the battle pass system to provide the level_id via payload. We changed routes in newer versions to have level id in the path.",
        "deprecated" : true
      },
      "EventPayload" : {
        "type" : "object",
        "properties" : {
          "user_id" : {
            "type" : "string",
            "description" : "This is your user id. You can set this to whatever you like, either your real user id or an obfuscated user id. However you need to be consistent here. Events linked to this user id only track if challenges or battle passes are unlocked with the same user id.",
            "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851"
          },
          "session_id" : {
            "type" : "string",
            "description" : "This is required if event_type is single and identifies a session. This can be anything used to group events together. For example this can be a level or a match id.",
            "example" : "12345"
          },
          "event_name" : {
            "type" : "string",
            "description" : "This is the event type as a string. These have predefined event names for many games and applications. It’s wise to use those as this allows us to analyse data and help you balancing your application or game.",
            "example" : "instant-death"
          },
          "event_type" : {
            "type" : "string",
            "description" : "This is either single or group. You can send multiple events in one request (group) or send events in sequence. Please note, that depending on your tier you might run into rate limits.",
            "example" : "single",
            "default" : "single"
          },
          "meta_data" : {
            "$ref" : "#/components/schemas/EventMetaData"
          },
          "team_id" : {
            "type" : "string",
            "description" : "Provide an optional team id that will be used in leaderboards to group results of teams.",
            "nullable" : true,
            "example" : "XYZ"
          }
        },
        "description" : "Events are the engine and driver for challenges, battle passes and leaderboards within the SCILL ecosystem. They are a simple, yet powerful data structure. The idea is, that you just send events for actions and things that happen in your game or application. SCILL leverages these info to update and progress challenges or to figure out the users score within a leaderboard. You don't have to handle any state in your application or game, as everything is done by SCILL."
      },
      "EventProperty" : {
        "type" : "object",
        "properties" : {
          "property_name" : {
            "type" : "string",
            "description" : "The name of the property. Is the field value in the event payloads meta_data.",
            "example" : "string"
          },
          "property_type" : {
            "type" : "string",
            "description" : "The type of the property. Can be number or string.",
            "example" : "number"
          }
        },
        "description" : "This object holds information about a proporty of an event. Events have required and optional properties."
      },
      "EventDescription" : {
        "type" : "object",
        "properties" : {
          "event_name" : {
            "type" : "string",
            "description" : "The name of the event, i.e kill-enemy. This will be used in the EventPayload as event_name.",
            "example" : "kill-enemy"
          },
          "required_properties" : {
            "type" : "array",
            "description" : "A list of required properties - properties that must be set",
            "items" : {
              "$ref" : "#/components/schemas/EventProperty"
            }
          },
          "optional_properties" : {
            "type" : "array",
            "description" : "A list of optional properties",
            "items" : {
              "$ref" : "#/components/schemas/EventProperty"
            }
          }
        },
        "description" : "Describes an available event structure"
      },
      "EventMetaData" : {
        "type" : "object",
        "properties" : {
          "action_object" : {
            "type" : "string",
            "description" : "The object that is the source of the action"
          },
          "action_subject" : {
            "type" : "string",
            "description" : "The object that is the target of the action"
          },
          "action_type" : {
            "type" : "string",
            "description" : "The name of the action"
          },
          "ammo_used" : {
            "type" : "integer",
            "description" : "Number of ammonition used"
          },
          "amount" : {
            "type" : "integer",
            "description" : "A general indicator for number of items (i.e. number of kills in kill-enemy event)"
          },
          "amount_gained" : {
            "type" : "integer",
            "description" : "The number of ammonition gained"
          },
          "amount_given" : {
            "type" : "integer",
            "description" : "The number of amminition given"
          },
          "animal_name" : {
            "type" : "string",
            "description" : "The name of an animal"
          },
          "armor" : {
            "type" : "integer",
            "description" : "The \"health\" state of the armor"
          },
          "away_team_id" : {
            "type" : "string",
            "description" : "The id of the opponent team"
          },
          "away_score" : {
            "type" : "integer",
            "description" : "The score of the opponent team"
          },
          "battle_status" : {
            "type" : "integer",
            "description" : "An integer value indicating the battle status (map it to an enum for example in your code)"
          },
          "bounty_name" : {
            "type" : "string",
            "description" : "The name of the bounty"
          },
          "building_id" : {
            "type" : "string",
            "description" : "The id or name of a building"
          },
          "building_level" : {
            "type" : "integer",
            "description" : "The level of the building"
          },
          "card_type" : {
            "type" : "string",
            "description" : "The name of the card"
          },
          "character_name" : {
            "type" : "string",
            "description" : "The name of a character"
          },
          "checkpoint_id" : {
            "type" : "string",
            "description" : "The id/name of a checkpint"
          },
          "coordinate_x" : {
            "type" : "integer",
            "description" : "The x coordinate in your coordinate system, used for example to store position on a map"
          },
          "coordinate_y" : {
            "type" : "integer",
            "description" : "The y coordinate in your coordinate system, used for example to store position on a map"
          },
          "crew_name" : {
            "type" : "string",
            "description" : "The name of a crew"
          },
          "damage_amount" : {
            "type" : "integer",
            "description" : "The amount of damage"
          },
          "distance" : {
            "type" : "integer",
            "description" : "The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value"
          },
          "duration" : {
            "type" : "integer",
            "description" : "The duration in any unit you like"
          },
          "effect_id" : {
            "type" : "string",
            "description" : "The effect id or name"
          },
          "enemy_character" : {
            "type" : "string",
            "description" : "The character type or name of an enemy"
          },
          "enemy_type" : {
            "type" : "string",
            "description" : "The type of an enemy"
          },
          "event_type" : {
            "type" : "string",
            "description" : "The event type"
          },
          "fuel_consumed" : {
            "type" : "integer",
            "description" : "The number of fuel consumed"
          },
          "health" : {
            "type" : "integer",
            "description" : "The health"
          },
          "hit_type" : {
            "type" : "string",
            "description" : "The type of a hit (i.e. head, torso, leg)"
          },
          "home_team_id" : {
            "type" : "string",
            "description" : "The id or name of your or the home team"
          },
          "home_score" : {
            "type" : "integer",
            "description" : "The score of your or the home team"
          },
          "item_id" : {
            "type" : "string",
            "description" : "The id of an item"
          },
          "item_name" : {
            "type" : "string",
            "description" : "The name of an item"
          },
          "item_type" : {
            "type" : "string",
            "description" : "The type of an item"
          },
          "kill_type" : {
            "type" : "string",
            "description" : "The type of a kill"
          },
          "lap_position" : {
            "type" : "integer",
            "description" : "The position in a lap"
          },
          "level_id" : {
            "type" : "string",
            "description" : "The id of the level"
          },
          "map_name" : {
            "type" : "string",
            "description" : "The name of a map"
          },
          "map_section_name" : {
            "type" : "string",
            "description" : "The name of a section of a map"
          },
          "mission_id" : {
            "type" : "string",
            "description" : "The mission id"
          },
          "player_character" : {
            "type" : "string",
            "description" : "The name of the player character"
          },
          "puzzle_id" : {
            "type" : "integer",
            "description" : "The id of a puzzle"
          },
          "race_position" : {
            "type" : "integer",
            "description" : "The position within a race"
          },
          "realm" : {
            "type" : "string",
            "description" : "The realm"
          },
          "required_time" : {
            "type" : "integer",
            "description" : "The time required involed in this event. I.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint."
          },
          "resource_gained" : {
            "type" : "string",
            "description" : "The name/id of the resource gained"
          },
          "resource_given" : {
            "type" : "string",
            "description" : "The name/id of the resource given (to someone else)"
          },
          "resource_name" : {
            "type" : "string",
            "description" : "The name of the resource"
          },
          "round_id" : {
            "type" : "integer",
            "description" : "The id of the round"
          },
          "round_type" : {
            "type" : "string",
            "description" : "The type of the round"
          },
          "score" : {
            "type" : "integer",
            "description" : "The score"
          },
          "stat_type" : {
            "type" : "string",
            "description" : "The type of the stats item"
          },
          "time_condition" : {
            "type" : "string",
            "description" : "The timing condition"
          },
          "transport_id" : {
            "type" : "string",
            "description" : "The id of the transport"
          },
          "type" : {
            "type" : "string",
            "description" : "The name/id of a type"
          },
          "unit_type" : {
            "type" : "string",
            "description" : "The name/id of a unit type"
          },
          "upgrade_type" : {
            "type" : "string",
            "description" : "The name of the upgrade"
          },
          "weapon_action" : {
            "type" : "string",
            "description" : "The action taken on a weapon (i.e. infrared-activated)"
          },
          "weapon_id" : {
            "type" : "string",
            "description" : "The id of the weapon"
          },
          "weapon_type" : {
            "type" : "string",
            "description" : "The type of the weapon"
          },
          "weapon_used" : {
            "type" : "string",
            "description" : "The name/id of a weapon used in a kill or similar event"
          },
          "zone_name" : {
            "type" : "string",
            "description" : "The name of the zone"
          }
        },
        "description" : "This holds metadata and is specific to each event type. Please have a look at the documentation to learn which properties need to be set for the event-type you want to send."
      },
      "Error" : {
        "required" : [ "message" ],
        "type" : "object",
        "properties" : {
          "code" : {
            "type" : "string"
          },
          "message" : {
            "type" : "string"
          }
        },
        "description" : "Errors are reported using this structure. Error messages are human readable and will be translated (if available) in the language provided by the language query parameter."
      },
      "UnknownChallengeError" : {
        "type" : "object",
        "properties" : {
          "error" : {
            "type" : "string",
            "description" : "The error message",
            "example" : "Unknown challenge type: asdfasdf-enemy"
          },
          "error_slug" : {
            "type" : "string",
            "description" : "Machine readable error message",
            "example" : "unknown_challenge_type_%s"
          },
          "status_code" : {
            "type" : "integer",
            "description" : "HTTP status code of this error message'",
            "example" : 400
          }
        }
      },
      "SocketToken" : {
        "required" : [ "socket_token" ],
        "type" : "object",
        "properties" : {
          "socket_token" : {
            "type" : "string",
            "example" : "eyJhbGciOiJIUzI1NiIsInR59...."
          }
        }
      },
      "NotificationTopic" : {
        "required" : [ "topic" ],
        "type" : "object",
        "properties" : {
          "topic" : {
            "type" : "string",
            "example" : "topic/challenges/3ea785c6d0ce23e67beff"
          }
        },
        "description" : "Realtime updates are implemented via MQTT - a resource efficient real time message system. Each user has it's own channel in our MQTT system that you need to request from the backend. This structure returns the topic for the user provided with the access token."
      },
      "AccessToken" : {
        "required" : [ "access_token" ],
        "type" : "object",
        "properties" : {
          "token" : {
            "type" : "string",
            "example" : "eyJhbGciOiJIUzI1NiIsInR59...."
          }
        },
        "description" : "As SCILL does not know anything about the users an access token is required to handle authentication. Requesting an access token in the backend returns this object that contains the token which needs to be set as the Authentication Bearer in subsequent requests to the SCILL backend."
      },
      "ForeignUserIdentifier" : {
        "required" : [ "user_id" ],
        "type" : "object",
        "properties" : {
          "user_id" : {
            "type" : "string",
            "description" : "Any string allowed, this is the foreign user identifier that has no relation in the SCILL database and the user is unkown to SCILL.",
            "example" : "123456789"
          }
        },
        "description" : "Requesting an access token requires this object to be sent containing the user id of your user. The user id can be anything (we dont care) but it must be consistent for the lifetime of the user."
      },
      "ChallengeWebhookPayload" : {
        "type" : "object",
        "properties" : {
          "webhook_type" : {
            "type" : "string",
            "description" : "The type of the webhook. Depending on the module, there are different webhook types indicating different events. Check the reference documentation to see all types.",
            "example" : "challenge-changed"
          },
          "category_position" : {
            "type" : "number",
            "description" : "The index of the category this challenge is linked to. When you request personal challenges, you get an array of categories which contain an array of challenges in their challenges property. This value indicates in which category this challenge can be found. Speeds up updating UI as you don't need to iterate through all catagories and challenges to find the challenge.",
            "example" : 1
          },
          "user_token" : {
            "type" : "string",
            "description" : "The access token for the user of that challenge. You can use that user_token to directly send another event and therefore to chain different SCILL pieces together. For example you can send another event driving another challenge or battle pass whenever a user has completed a challenge.",
            "example" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ..."
          },
          "new_challenge" : {
            "$ref" : "#/components/schemas/Challenge"
          },
          "old_challenge" : {
            "$ref" : "#/components/schemas/Challenge"
          }
        },
        "description" : "The payload sent to the users webhook."
      },
      "BattlePassUnlockPayload" : {
        "required" : [ "purchase_currency", "purchase_price" ],
        "type" : "object",
        "properties" : {
          "purchase_price" : {
            "type" : "number",
            "description" : "The purchase price. Set to 0 if this was free. The idea behind this is to provide information via an Admin Panel on average purchase price and to also allow showing users purchase info in their user account.",
            "example" : 5.99
          },
          "purchase_currency" : {
            "type" : "string",
            "description" : "The currency (EUR, USD, etc) of the purchase price",
            "example" : "EUR"
          }
        },
        "description" : "Unlocking a battle pass requires some info to be sent so we can validate everything is ok"
      },
      "BattlePassUnlockInfo" : {
        "type" : "object",
        "properties" : {
          "purchase_id" : {
            "type" : "string",
            "description" : "The id of this battle pass purchase",
            "example" : "603793843025346562"
          },
          "battle_pass_id" : {
            "type" : "string",
            "description" : "The battle pass id",
            "example" : "603693723277918210"
          },
          "user_id" : {
            "type" : "string",
            "description" : "The user id of this battle pass purchase",
            "example" : "1234"
          },
          "purchase_price" : {
            "type" : "number",
            "description" : "The price paid for this battle pass",
            "example" : 5.99
          },
          "purchase_currency" : {
            "type" : "string",
            "description" : "The currency used to purchase this battle pass",
            "example" : "EUR"
          },
          "purchased_at" : {
            "type" : "string",
            "description" : "The date this battle pass has been purchased",
            "example" : "2020-11-02T16:14:17Z"
          },
          "battle_pass_completed" : {
            "type" : "boolean",
            "description" : "Indicates if this battle pass has been completed",
            "example" : false
          }
        }
      },
      "BattlePassChallengeChangedPayload" : {
        "type" : "object",
        "properties" : {
          "webhook_type" : {
            "type" : "string",
            "description" : "The type of the notification. If you receive this payload, it's most likely battlepass-challenge-changed",
            "example" : "battlepass-challenge-changed"
          },
          "old_battle_pass_challenge" : {
            "$ref" : "#/components/schemas/BattlePassChallengeState"
          },
          "new_battle_pass_challenge" : {
            "$ref" : "#/components/schemas/BattlePassChallengeState"
          }
        },
        "description" : "This payload is sent in Webhooks and notifications as part of the battlepass-challenge-changed notification. The idea is to provide enough information to quickly update UI or implementing backend logic. We provide both the state of the object before it changed, and after that. This allows you to react in many different ways."
      },
      "BattlePassChallengeState" : {
        "type" : "object",
        "properties" : {
          "app_id" : {
            "type" : "string",
            "description" : "The unique id of the app",
            "example" : "597737952688570369"
          },
          "battle_pass_id" : {
            "type" : "string",
            "description" : "The unique id of this battle pass.",
            "example" : "603693723277918210"
          },
          "level_id" : {
            "type" : "string",
            "description" : "Unique id of this BattlePassLevel object.",
            "example" : "563006391671062538"
          },
          "user_id" : {
            "type" : "string",
            "description" : "This is your user id. You can set this to whatever you like, either your real user id or an obfuscated user id. However you need to be consistent here. Events linked to this user id only track if challenges or battle passes are unlocked with the same user id.",
            "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851"
          },
          "level_position_index" : {
            "type" : "integer",
            "description" : "Typical usage pattern is to load battle pass levels with getBattlePassLevels operation and store them for rendering. Using this value you can quickly identify the index of the level that changed.",
            "example" : 0
          },
          "challenge_id" : {
            "type" : "string",
            "description" : "The unique id of this challenge. Every challenge is linked to a product.",
            "example" : "505538946732425217"
          },
          "challenge_position_index" : {
            "type" : "integer",
            "description" : "Same as level_position_index. Use this index to identify the challenge that changed within the levels challenges array. Typical usage pattern is to update the previously stored score and type.",
            "example" : 1
          },
          "challenge_goal" : {
            "type" : "integer",
            "description" : "Indicates how many “tasks” must be completed or done to complete this challenge.",
            "example" : 5
          },
          "user_challenge_current_score" : {
            "type" : "integer",
            "description" : "Indicates how many tasks the user already has completed. Use this in combination with challenge_goal to render a nice progress bar.",
            "example" : 0
          },
          "type" : {
            "type" : "string",
            "description" : "Indicates the status of the challenge. This can be one of the following unlock: Challenge does not track anything. in-progress: Challenge is active and tracking. overtime: User did not manage to finish the challenge in time. unclaimed: The challenge has been completed but the reward has not yet been claimed. finished: The challenge has been successfully be completed and the reward has been claimed",
            "example" : "unlock"
          }
        },
        "description" : "This object stores information about a battle pass challenge state. It is designed to update challenges loaded previously with the getBattlePassLevels API. Indices allow you to quickly update locally stored Challenge objects without iterating or reloading data."
      },
      "BattlePassLevelReward" : {
        "type" : "object",
        "properties" : {
          "app_id" : {
            "type" : "string",
            "description" : "The unique id of the app",
            "example" : "597737952688570369"
          },
          "battle_pass_id" : {
            "type" : "string",
            "description" : "The unique id of this battle pass.",
            "example" : "603693723277918210"
          },
          "level_id" : {
            "type" : "string",
            "description" : "Unique id of this BattlePassLevel object.",
            "example" : "563006391671062538"
          },
          "user_id" : {
            "type" : "string",
            "description" : "This is your user id. You can set this to whatever you like, either your real user id or an obfuscated user id. However you need to be consistent here. Events linked to this user id only track if challenges or battle passes are unlocked with the same user id.",
            "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851"
          },
          "level_position_index" : {
            "type" : "integer",
            "description" : "Typical usage pattern is to load battle pass levels with getBattlePassLevels operation and store them for rendering. Using this value you can quickly identify the index of the level that changed.",
            "example" : 0
          },
          "reward_amount" : {
            "type" : "string",
            "description" : "In the Admin Panel you can set different types of rewards. You can also set an identifier of an in-game-item or anything you like. Use this to include the reward into your own business logic.",
            "example" : "100"
          },
          "reward_type_name" : {
            "type" : "string",
            "description" : "There are different types of rewards available. Possible values are Coins, Voucher, Money and Experience.",
            "example" : "Coins"
          }
        },
        "description" : "This objects holds information about a battle pass reward"
      },
      "BattlePassLevelClaimedPayload" : {
        "type" : "object",
        "properties" : {
          "webhook_type" : {
            "type" : "string",
            "description" : "The type of the notification. If you receive this payload, it's most likely battlepass-level-reward-claimed",
            "example" : "battlepass-level-reward-claimed"
          },
          "battle_pass_level_reward_claimed" : {
            "$ref" : "#/components/schemas/BattlePassLevelReward"
          }
        },
        "description" : "Payload sent via Webhook or realtime notifications whenever a usrs level reward has been claimed. Use this payload to unlock the item for the specified user."
      },
      "BattlePassState" : {
        "type" : "object",
        "properties" : {
          "battle_pass_id" : {
            "type" : "string",
            "description" : "The unique id of this battle pass.",
            "example" : "603693723277918210"
          },
          "app_id" : {
            "type" : "string",
            "description" : "The unique id of the app",
            "example" : "597737952688570369"
          },
          "battle_pass_priority" : {
            "type" : "integer",
            "description" : "The priority of the battle pass. I.e. if multiple are available you can use this field to sort them.",
            "example" : 1
          },
          "start_date" : {
            "type" : "string",
            "description" : "The date (in iso format) when the Battle Pass starts. Tracking begins once this date is passed.",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          },
          "end_date" : {
            "type" : "string",
            "description" : "The date (in iso format) when the Battle Pass ends. Tracking stops once the end is reached and users will not be able to progress further than what they have achieved up to that point.",
            "format" : "RFC3339",
            "example" : "2020-08-17T00:00:00Z"
          },
          "is_active" : {
            "type" : "boolean",
            "description" : "Indicated if this battle pass is active.",
            "example" : false
          }
        },
        "description" : "This object holds some basic info about lifetime of a battle pass and is used in expired notifications."
      },
      "LeaderboardV2Results_leaderboard_results_by_member_type" : {
        "type" : "object",
        "properties" : {
          "team" : {
            "$ref" : "#/components/schemas/LeaderboardV2MemberTypeRanking"
          },
          "user" : {
            "$ref" : "#/components/schemas/LeaderboardV2MemberTypeRanking"
          }
        },
        "description" : "This object uses two keys - \"user\" and \"team\", both of which contain ranking info"
      }
    },
    "responses" : {
      "BattlePassUnlocked" : {
        "description" : "Returns unlock info about a battle pass",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/BattlePassUnlockInfo"
            }
          }
        }
      },
      "ActionSuccessful" : {
        "description" : "The action has been successful",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/ActionResponse"
            }
          }
        }
      },
      "UnknownChallengeType" : {
        "description" : "The event type is not supported",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/UnknownChallengeError"
            }
          }
        }
      },
      "NotFound" : {
        "description" : "The specified resource was not found",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized" : {
        "description" : "Unauthorized",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/Error"
            }
          }
        }
      },
      "RequestNotPossible" : {
        "description" : "This request could not be performed. Most of the time this happens if the action already has been executed before.",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/Error"
            }
          }
        }
      },
      "BadRequest" : {
        "description" : "Request could not complete as parameters were missing or were not set correctely.",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/Error"
            }
          }
        }
      },
      "SocketToken" : {
        "description" : "Response with Socket Token",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/ActionResponse"
            }
          }
        }
      }
    },
    "securitySchemes" : {
      "BearerAuth" : {
        "type" : "http",
        "description" : "You can either use the API-Key or an Access Token generated earlier with the auth/generate-access-token route. Only use API-Key on server side, never expose it on client side. Use Access Tokens where possible. More info on this topic can be found here https://developers.4players.io/scill/api/authentication/",
        "scheme" : "bearer",
        "bearerFormat" : "Access Token or API-Key"
      },
      "oAuthNoScopes" : {
        "type" : "oauth2",
        "flows" : {
          "implicit" : {
            "authorizationUrl" : "https://api.example.com/oauth2/authorize",
            "scopes" : { }
          }
        }
      },
      "ApiKeyType" : {
        "type" : "apiKey",
        "description" : "Set to access_token if you have assigned an access token and leave empty if you use an API key",
        "name" : "auth",
        "in" : "query"
      }
    }
  }
}