Project APIExperiments (V2)
Change experiment rollout
Change a scheduled or active experiment's staged rollout: set a percentage, advance to the next scheduled step, pause or resume the schedule, or replaceSteps with a new one. Takes effect on the next SDK request. Only changes who may newly enroll — already-enrolled units keep their group, so lowering or pausing stops new enrollment and evicts no one. Group weights are unchanged.
Authorization
personalAccessTokenAuth AuthorizationBearer <token>
Personal access token (prefixed gb_pat_). Acts on behalf of its owner and can never exceed the owner's own permissions. Send it as Authorization: Bearer <token>.
In: header
Path Parameters
applicationId*integer
Range
0 < value <= 9007199254740991experimentId*integer
Range
0 < value <= 9007199254740991Header Parameters
environment_id*number
Gamebeast environment ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/application/1/v2/experiments/1/rollout" \ -H "environment_id: 0" \ -H "Content-Type: application/json" \ -d '{ "action": "set", "rolloutBps": 0, "reason": "string" }'{ "rollout": { "initialBps": 0, "rolloutBps": 0, "rolloutSetAt": "2019-08-24T14:15:22Z", "pausedAt": "2019-08-24T14:15:22Z", "steps": [ { "targetBps": -9007199254740991, "startsAt": "2019-08-24T14:15:22Z" } ], "effectiveBps": 0 }, "events": [ { "kind": "created", "fromBps": 0, "toBps": 0, "reason": "string", "actorId": "d2f1b55c-8cee-4a0d-af57-aebaeff77518", "occurredAt": "2019-08-24T14:15:22Z" } ]}