ROroblox
Experiments

Completes an experiment by stopping it and rolling out the requested variant.

Changed on
post/creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe:write

Path parameters

universeIdinteger required
experimentIdstring required

Request body

variantIdstring nullable

ID of the variant to roll out as the winning variant. If omitted, the experiment is stopped without rolling out a winner.

Response

OK

Changes

  • bcfdc20689cdRevision changes
    • breaking

      the //////////////////////////////// response's property type changed from string to boolean for status

    • breaking

      the //////////////////////////////// response's property type changed from string to number, and format from no format to double for status

    • breaking

      the //////////////////////////////// response's property type changed from string to integer, and format from no format to int64 for status

    • breaking

      the ////////////////////// response's property type changed from string to no type for status

    • info

      added to the ////////////////////// response property allOf list for the response status

  • 7c6787738100Revision changes
    • warning

      added the new EXPERIMENT_API_ERROR_TYPE_CONFIGS_KEY_HAS_RESERVED_PREFIX enum value to the ////////////// response property for the response status