{"info":{"title":"trials 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/trials/admin/data":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetS3DataResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"id","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/trials/data":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveGameDataResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadTrialDataRequest"}}}},"security":[{"user":[]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialSuccessResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTrialDataRequest"}}}},"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/trials/pause":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialSuccessResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PauseTrialRequest"}}}},"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/trials/schedule":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialSuccessResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleTrialRequest"}}}},"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/trials/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTrialsResponse"}}}},"400":{"description":"Bad Request"}},"security":[{"user":["tester"]},{"server":[]}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialSuccessResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTrialRestRequest"}}}},"security":[{"user":[]},{"server":[]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialSuccessResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTrialRequest"}}}},"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/trials/admin":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPlayerTrialsResponse"}}}},"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/trials/start":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrialSuccessResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTrialRequest"}}}},"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}]}},"components":{"schemas":{"ScheduleTrialRequest":{"properties":{"name":{"type":"string"},"time":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Schedule Trial Request","type":"object","required":["name","time"]},"Trial":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"activated":{"type":"integer","format":"int64"},"cohorts":{"type":"array","items":{"$ref":"#/components/schemas/Cohort"}},"ctype":{"type":"string"},"scheduleStart":{"type":"integer","format":"int64"},"assigned":{"type":"integer","format":"int64"},"strategy":{"type":"string"},"customRules":{"type":"array","items":{"$ref":"#/components/schemas/CustomCohortRule"}},"ttype":{"type":"string"},"created":{"type":"integer","format":"int64"},"active":{"type":"boolean"}},"required":["ttype","name","strategy","active","assigned","ctype","cohorts"]},"CustomCohortRule":{"type":"object","additionalProperties":false,"properties":{"customOp":{"type":"string"},"domain":{"type":"string"},"customItems":{"type":"array","items":{"$ref":"#/components/schemas/CustomCohortRule"}},"customAttr":{"type":"string"},"customVal":{"type":"array","items":{"type":"string"}},"access":{"type":"string"}},"required":["customAttr","customOp","customVal"]},"Cohort":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"customRule":{"type":"array","items":{"$ref":"#/components/schemas/CustomCohortRule"}},"populationCap":{"type":"integer","format":"int64"},"assigned":{"type":"integer","format":"int64"},"pct":{"type":"integer","format":"int32"},"cloudData":{"type":"array","items":{"$ref":"#/components/schemas/CloudStorage"}}},"required":["name","assigned"]},"DeleteTrialDataRequest":{"properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Delete Trial Data Request","type":"object","required":["id"]},"CloudDataStatus":{"type":"object","additionalProperties":false,"properties":{"ejected":{"type":"boolean"},"processing":{"type":"boolean"},"sent":{"type":"boolean"},"forSending":{"type":"boolean"}},"required":["ejected","processing","sent","forSending"]},"SaveGameDataResponse":{"properties":{"result":{"type":"string"},"sid":{"type":"integer","format":"int64"},"version":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Save Game Data Response","type":"object","required":["result","sid","version"]},"PauseTrialRequest":{"properties":{"name":{"type":"string"}},"additionalProperties":false,"title":"Pause Trial Request","type":"object","required":["name"]},"StartTrialRequest":{"properties":{"name":{"type":"string"}},"additionalProperties":false,"title":"Start Trial Request","type":"object","required":["name"]},"CloudStorage":{"type":"object","additionalProperties":false,"properties":{"retrieved":{"type":"integer","format":"int64"},"uniqueIdentifier":{"type":"string"},"ejected":{"type":"boolean"},"data":{"type":"string"},"ref":{"type":"string"},"version":{"type":"integer","format":"int64"},"added":{"type":"integer","format":"int64"},"stype":{"type":"integer","format":"int32"},"updated":{"type":"integer","format":"int64"},"status":{"$ref":"#/components/schemas/CloudDataStatus"},"jobId":{"type":"string"},"sent":{"type":"boolean"},"expiration":{"type":"integer","format":"int64"},"gt":{"type":"integer","format":"int64"},"sid":{"type":"integer","format":"int64"}},"required":["sid","stype","sent","ejected","status"]},"ListTrialsResponse":{"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Trial"}}},"additionalProperties":false,"title":"List Trials Response","type":"object","required":["result"]},"CohortEntry":{"type":"object","additionalProperties":false,"properties":{"trial":{"type":"string"},"cohort":{"type":"string"}},"required":["trial","cohort"]},"GetPlayerTrialsResponse":{"properties":{"trials":{"type":"array","items":{"$ref":"#/components/schemas/CohortEntry"}},"cohortData":{"type":"array","items":{"$ref":"#/components/schemas/CloudStorage"}}},"additionalProperties":false,"title":"Get Player Trials Response","type":"object","required":["trials","cohortData"]},"GetS3DataResponse":{"properties":{"data":{"type":"array","items":{"type":"integer"}}},"additionalProperties":false,"title":"Get S 3 Data Response","type":"object","required":["data"]},"CreateTrialRestRequest":{"properties":{"name":{"type":"string"},"cohorts":{"type":"string"},"cohortType":{"type":"string"},"strat":{"type":"string"},"customRules":{"type":"array","items":{"$ref":"#/components/schemas/TrialCustomRule"}}},"additionalProperties":false,"title":"Create Trial Rest Request","type":"object","required":["name","strat","cohortType","cohorts"]},"UploadTrialDataRequest":{"properties":{"trialName":{"type":"string"},"cohortName":{"type":"string"},"dataName":{"type":"string"},"filePayloadBase64":{"type":"string"}},"additionalProperties":false,"title":"Upload Trial Data Request","type":"object","required":["trialName","cohortName","dataName","filePayloadBase64"]},"TrialCustomRule":{"type":"object","additionalProperties":false,"properties":{"customOp":{"type":"string"},"domain":{"type":"string"},"customItems":{"type":"array","items":{"$ref":"#/components/schemas/TrialCustomRule"}},"customAttr":{"type":"string"},"customVal":{"type":"array","items":{"type":"string"}},"access":{"type":"string"}},"required":["customAttr","customOp","customVal"]},"GetS3DataRequest":{"properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Get S 3 Data Request","type":"object","required":["id"]},"DeleteTrialRequest":{"properties":{"trialType":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false,"title":"Delete Trial Request","type":"object","required":["name"]},"GetPlayerTrialsRequest":{"properties":{"dbid":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Get Player Trials Request","type":"object","required":["dbid"]},"TrialSuccessResponse":{"properties":{"result":{"type":"boolean"}},"additionalProperties":false,"title":"Trial Success 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"}