GamebeastDocs
Dashboard
Project APIExperiments (V2)

Get experiment rollout

GET
/application/{applicationId}/v2/experiments/{experimentId}/rollout

The experiment's staged rollout — the share of eligible units allowed to enroll, evaluated now — and its timeline: every operator action plus each scheduled step that has taken effect, oldest first.

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
Range0 < value <= 9007199254740991
experimentId*integer
Range0 < value <= 9007199254740991

Header Parameters

environment_id*number

Gamebeast environment ID

Response Body

application/json

curl -X GET "https://example.com/application/1/v2/experiments/1/rollout" \  -H "environment_id: 0"
{  "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"    }  ]}