GamebeastDocs
Dashboard

List active experiments with changesets

GET
/sdk/v2/experiments/active

Returns all active experiments for the authenticated environment and unit type, including group definitions and full changeset operations. Designed for server-side SDKs that cache experiment structure and apply changesets locally after resolving assignments via the bulk endpoint. Supports hash-based change detection: send the previous hash as ?hash= (or via If-None-Match) to receive 304 when the catalog is unchanged. Private experiments are returned to secret keys only.

Authorization

sdkApiKey
authorization<token>

SDK (public) key, prefixed gb_pk_ (older keys: sdk_). Send it as the authorization header value. Scoped to one project, so it is safe to ship in a game build.

In: header

Query Parameters

unit-type*string

Value in

  • "user"
  • "server"
hash?string
Length1 <= length

Header Parameters

environment?string

Environment alias. Defaults to development when omitted; studio is accepted as a synonym for it. Any alias outside the calling key's environment scope is rejected with 403.

Length1 <= length

Value in

  • "production"
  • "development"
project-id?integer
Range0 < value <= 9007199254740991

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/sdk/v2/experiments/active?unit-type=user"
{  "hash": "string",  "requiredProperties": [    "string"  ],  "experiments": [    {      "id": 0,      "name": "string",      "unitType": "user",      "assignmentMode": "weightedHash",      "baseConfigurationId": 0,      "autoAssignment": true,      "permanentEnrollment": true,      "requiredProperties": [        "string"      ],      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "groups": [        {          "id": 0,          "label": "string",          "weight": 0,          "ordinal": 0,          "changeset": {            "operations": [              {                "op": "set",                "path": [                  "string"                ],                "value": null              }            ]          }        }      ]    }  ]}