{"info":{"title":"leaderboards basic","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/basic/leaderboards/list":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardListResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"skip","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prefix","in":"query","schema":{"type":"string"},"required":false},{"name":"includePartitions","in":"query","schema":{"type":"boolean"},"required":false}],"security":[{"user":["tester"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/leaderboards/player":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLeaderBoardViewResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"dbid","in":"query","schema":{"type":"integer","format":"int64"},"required":true}],"security":[{"user":["tester"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/leaderboards/assignment":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardAssignmentInfo"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"boardId","in":"query","schema":{"type":"string"},"required":true},{"name":"joinBoard","in":"query","schema":{"type":"boolean"},"required":false}],"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/leaderboards/uid":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardUidResponse"}}}},"400":{"description":"Bad Request"}},"security":[{"user":["tester"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"RankEntryStat":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"LeaderboardUidResponse":{"properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Uid Response","type":"object","required":["id"]},"ListLeaderBoardViewResponse":{"properties":{"result":{"type":"string"},"lbs":{"type":"array","items":{"$ref":"#/components/schemas/LeaderBoardView"}}},"additionalProperties":false,"title":"List Leader Board View Response","type":"object","required":["result","lbs"]},"RankEntry":{"type":"object","additionalProperties":false,"properties":{"stats":{"type":"array","items":{"$ref":"#/components/schemas/RankEntryStat"}},"rank":{"type":"integer","format":"int64"},"score":{"type":"number","format":"double"},"columns":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"gt":{"type":"integer","format":"int64"}},"required":["gt","rank","columns"]},"LeaderboardPlayerAssignmentRequest":{"properties":{"boardId":{"type":"string"},"joinBoard":{"type":"boolean"}},"additionalProperties":false,"title":"Leaderboard Player Assignment Request","type":"object","required":["boardId"]},"LeaderboardPlayerRequest":{"properties":{"dbid":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Player Request","type":"object","required":["dbid"]},"LeaderboardListRequest":{"properties":{"skip":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"prefix":{"type":"string"},"includePartitions":{"type":"boolean"}},"additionalProperties":false,"title":"Leaderboard List Request","type":"object"},"LeaderboardAssignmentInfo":{"properties":{"playerId":{"type":"integer","format":"int64"},"leaderboardId":{"type":"string"}},"additionalProperties":false,"title":"Leaderboard Assignment Info","type":"object","required":["playerId","leaderboardId"]},"LeaderboardListResponse":{"properties":{"total":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"nameList":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"title":"Leaderboard List Response","type":"object","required":["total","offset","nameList"]},"LeaderBoardView":{"type":"object","additionalProperties":false,"properties":{"lbId":{"type":"string"},"boardSize":{"type":"integer","format":"int64"},"rankgt":{"$ref":"#/components/schemas/RankEntry"},"rankings":{"type":"array","items":{"$ref":"#/components/schemas/RankEntry"}}},"required":["lbId","boardSize","rankings"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}