{"info":{"title":"leaderboards object","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/object/leaderboards/{objectId}/entries":{"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["developer"]},{"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}]},"/object/leaderboards/{objectId}/membership":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardMembershipResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"playerId","in":"query","schema":{"type":"integer","format":"int64"},"required":true},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"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}]},"/object/leaderboards/{objectId}/ranks":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderBoardViewResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"ids","in":"query","schema":{"type":"string"},"required":true},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{}]},"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}]},"/object/leaderboards/{objectId}/partition":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardPartitionInfo"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"playerId","in":"query","schema":{"type":"integer","format":"int64"},"required":true},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"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}]},"/object/leaderboards/{objectId}/friends":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderBoardViewResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"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}]},"/object/leaderboards/{objectId}/":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardCreateRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["developer"]},{"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}]},"/object/leaderboards/{objectId}/matches":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchMakingMatchesPvpResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"poolSize","in":"query","schema":{"type":"integer","format":"int32"},"required":true},{"name":"windows","in":"query","schema":{"type":"integer","format":"int32"},"required":true},{"name":"windowSize","in":"query","schema":{"type":"integer","format":"int32"},"required":true},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{}]},"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}]},"/object/leaderboards/{objectId}/assignment":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardAssignmentInfo"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":[]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardRemoveCacheEntryRequest"}}}},"security":[{"user":["developer"]},{"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}]},"/object/leaderboards/{objectId}/entry":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardAddRequest"}}}},"security":[{}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardRemoveEntryRequest"}}}},"security":[{"user":["developer"]},{"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}]},"/object/leaderboards/{objectId}/freeze":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["developer"]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{"user":["developer"]},{"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}]},"/object/leaderboards/{objectId}/details":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardDetails"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"from","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"max","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"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}]},"/object/leaderboards/{objectId}/view":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderBoardViewResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"max","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"focus","in":"query","schema":{"type":"integer","format":"int64"},"required":false},{"name":"friends","in":"query","schema":{"type":"boolean"},"required":false},{"name":"from","in":"query","schema":{"type":"integer","format":"int32"},"required":false},{"name":"outlier","in":"query","schema":{"type":"integer","format":"int64"},"required":false},{"name":"guild","in":"query","schema":{"type":"boolean"},"required":false},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"security":[{}]},"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}]},"/object/leaderboards/{objectId}/swap":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Leaderboard ID","required":true,"x-beamable-object-id":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardSwapRequest"}}}},"security":[{"user":["developer"]},{"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":{"LeaderboardCohort":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"description":{"type":"string"},"statRequirements":{"type":"array","items":{"$ref":"#/components/schemas/PlayerStatRequirement"}}},"required":["id","statRequirements"]},"LeaderboardPartitionInfo":{"properties":{"playerId":{"type":"integer","format":"int64"},"leaderboardId":{"type":"string"},"isEmpty":{"type":"boolean"},"partition":{"type":"integer","format":"int32"}},"additionalProperties":false,"title":"Leaderboard Partition Info","type":"object","required":["playerId","leaderboardId","isEmpty"]},"LeaderboardPartitionRequest":{"properties":{"playerId":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Partition Request","type":"object","required":["playerId"]},"LeaderboardCohortSettings":{"type":"object","additionalProperties":false,"properties":{"cohorts":{"type":"array","items":{"$ref":"#/components/schemas/LeaderboardCohort"}}},"required":["cohorts"]},"OrderRule":{"type":"object","additionalProperties":false,"properties":{"v":{"type":"string"},"o":{"type":"integer","format":"int32"}},"required":["v","o"]},"LeaderboardMembershipRequest":{"properties":{"playerId":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Membership Request","type":"object","required":["playerId"]},"RankEntryStat":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"LeaderboardRemoveCacheEntryRequest":{"properties":{"playerId":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Remove Cache Entry Request","type":"object","required":["playerId"]},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"LeaderboardGetRanksRequest":{"properties":{"ids":{"type":"string"}},"additionalProperties":false,"title":"Leaderboard Get Ranks Request","type":"object","required":["ids"]},"LeaderboardApiViewRequest":{"properties":{"max":{"type":"integer","format":"int32"},"focus":{"type":"integer","format":"int64"},"friends":{"type":"boolean"},"from":{"type":"integer","format":"int32"},"outlier":{"type":"integer","format":"int64"},"guild":{"type":"boolean"}},"additionalProperties":false,"title":"Leaderboard Api View Request","type":"object"},"MetadataView":{"type":"object","additionalProperties":false,"properties":{"freezeTime":{"type":"integer","format":"int64"},"derivatives":{"type":"array","items":{"type":"string"}},"parentLeaderboard":{"type":"string"},"cohortSettings":{"$ref":"#/components/schemas/LeaderboardCohortSettings"},"permissions":{"$ref":"#/components/schemas/ClientPermission"},"frozen":{"type":"boolean"},"maxEntries":{"type":"integer","format":"int32"},"partitioned":{"type":"boolean"},"cohorted":{"type":"boolean"},"expiration":{"type":"integer","format":"int64"}},"required":["parentLeaderboard","partitioned","cohorted","frozen"]},"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"]},"PlayerStatRequirement":{"type":"object","additionalProperties":false,"properties":{"domain":{"type":"string"},"stat":{"type":"string"},"constraint":{"type":"string"},"value":{"type":"string"},"access":{"type":"string"}},"required":["stat","constraint","value"]},"ClientPermission":{"type":"object","additionalProperties":false,"properties":{"write_self":{"type":"boolean"}},"required":["write_self"]},"MatchMakingRanking":{"type":"object","additionalProperties":false,"properties":{"gt":{"type":"integer","format":"int64"},"rank":{"type":"integer","format":"int32"},"isUnranked":{"type":"boolean"},"variables":{"type":"object","additionalProperties":{"type":"string"}}},"required":["gt","rank","isUnranked","variables"]},"LeaderBoardViewResponse":{"properties":{"result":{"type":"string"},"lb":{"$ref":"#/components/schemas/LeaderBoardView"}},"additionalProperties":false,"title":"Leader Board View Response","type":"object","required":["result","lb"]},"LeaderboardDetails":{"properties":{"lbid":{"type":"string"},"orules":{"$ref":"#/components/schemas/OrderRules"},"numberOfEntries":{"type":"integer","format":"int32"},"fullName":{"type":"string"},"metaData":{"$ref":"#/components/schemas/MetadataView"},"view":{"$ref":"#/components/schemas/LeaderBoardView"}},"additionalProperties":false,"title":"Leaderboard Details","type":"object","required":["fullName","lbid","numberOfEntries","view"]},"OrderRules":{"type":"object","additionalProperties":false,"properties":{"orules":{"type":"array","items":{"$ref":"#/components/schemas/OrderRule"}}},"required":["orules"]},"LeaderboardRemoveEntryRequest":{"properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Remove Entry Request","type":"object","required":["id"]},"LeaderboardAssignmentInfo":{"properties":{"playerId":{"type":"integer","format":"int64"},"leaderboardId":{"type":"string"}},"additionalProperties":false,"title":"Leaderboard Assignment Info","type":"object","required":["playerId","leaderboardId"]},"MatchMakingMatchesPvpResponse":{"properties":{"result":{"type":"string"},"totalEntries":{"type":"integer","format":"int32"},"playerRank":{"$ref":"#/components/schemas/MatchMakingRanking"},"windows":{"type":"array","items":{"$ref":"#/components/schemas/MatchMakingWindowResp"}}},"additionalProperties":false,"title":"Match Making Matches Pvp Response","type":"object","required":["result","totalEntries","playerRank","windows"]},"LeaderboardGetMatchRequest":{"properties":{"poolSize":{"type":"integer","format":"int32"},"windows":{"type":"integer","format":"int32"},"windowSize":{"type":"integer","format":"int32"}},"additionalProperties":false,"title":"Leaderboard Get Match Request","type":"object","required":["poolSize","windows","windowSize"]},"LeaderboardCreateRequest":{"properties":{"freezeTime":{"type":"integer","format":"int64"},"derivatives":{"type":"array","items":{"type":"string"}},"scoreName":{"type":"string"},"cohortSettings":{"$ref":"#/components/schemas/LeaderboardCohortSettings"},"permissions":{"$ref":"#/components/schemas/ClientPermission"},"maxEntries":{"type":"integer","format":"int32"},"partitioned":{"type":"boolean"},"sharded":{"type":"boolean"},"ttl":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Create Request","type":"object","required":["sharded"]},"LeaderboardDetailsRequest":{"properties":{"from":{"type":"integer","format":"int32"},"max":{"type":"integer","format":"int32"}},"additionalProperties":false,"title":"Leaderboard Details Request","type":"object"},"MatchMakingWindowResp":{"type":"object","additionalProperties":false,"properties":{"difficulty":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/MatchMakingRanking"}}},"required":["difficulty","matches"]},"LeaderboardSwapRequest":{"properties":{"winnerId":{"type":"integer","format":"int64"},"loserId":{"type":"integer","format":"int64"},"swapBase":{"type":"integer","format":"int64"},"delta":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Leaderboard Swap Request","type":"object","required":["swapBase","delta"]},"LeaderboardAddRequest":{"properties":{"maxScore":{"type":"number","format":"double"},"stats":{"type":"object","additionalProperties":{"type":"string"}},"score":{"type":"number","format":"double"},"minScore":{"type":"number","format":"double"},"id":{"type":"integer","format":"int64"},"increment":{"type":"boolean"}},"additionalProperties":false,"title":"Leaderboard Add Request","type":"object","required":["id","score"]},"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"]},"LeaderboardMembershipResponse":{"properties":{"result":{"type":"boolean"}},"additionalProperties":false,"title":"Leaderboard Membership Response","type":"object","required":["result"]}},"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"}