ROroblox
Experiments

Creates a new experiment for a universe.

Changed on

Returns an ExperimentOperation describing the async create call.

post/creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments
  • 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

Request body

namestring nullable

Experiment display name.

descriptionstring nullable

Experiment description.

exposurePercentinteger

Exposure percent in range 0-100. Percent of eligible users seeing the experiment.

durationSecondsinteger

Experiment duration in whole seconds.

universeGoalMetric'UNIVERSE_EXPERIMENT_METRIC_AVERAGE_SESSION_TIME' | 'UNIVERSE_EXPERIMENT_METRIC_PLAYTIME_PER_USER' | 'UNIVERSE_EXPERIMENT_METRIC_DAY_1_RETENTION' | 'UNIVERSE_EXPERIMENT_METRIC_DAY_7_RETENTION' | 'UNIVERSE_EXPERIMENT_METRIC_PAYER_CONVERSION_RATE' | 'UNIVERSE_EXPERIMENT_METRIC_AVERAGE_REVENUE_PER_USER' | 'UNIVERSE_EXPERIMENT_METRIC_AVERAGE_REVENUE_PER_PAYING_USER'

Metric tracked for a universe experiment.

UNIVERSE_EXPERIMENT_METRIC_AVERAGE_SESSION_TIME

UNIVERSE_EXPERIMENT_METRIC_PLAYTIME_PER_USER

UNIVERSE_EXPERIMENT_METRIC_DAY_1_RETENTION

UNIVERSE_EXPERIMENT_METRIC_DAY_7_RETENTION

UNIVERSE_EXPERIMENT_METRIC_PAYER_CONVERSION_RATE

UNIVERSE_EXPERIMENT_METRIC_AVERAGE_REVENUE_PER_USER

UNIVERSE_EXPERIMENT_METRIC_AVERAGE_REVENUE_PER_PAYING_USER

Response

OK

Changes

  • bcfdc20689cdRevision changes
    • breaking

      added to the //////////////// request property allOf list (media type: application/json-patch+json)

    • breaking

      added to the //////////////// request property allOf list (media type: application/json)

    • breaking

      added to the //////////////// request property allOf list (media type: text/json)

    • breaking

      added to the //////////////// request property allOf list (media type: application/*+json)

    • breaking

      the ////////////////////////// request property type changed from string to boolean (media type: application/json-patch+json)

    • breaking

      the ////////////////////////// request property type changed from string to boolean (media type: application/json)

    • breaking

      the ////////////////////////// request property type changed from string to boolean (media type: text/json)

    • breaking

      the ////////////////////////// request property type changed from string to boolean (media type: application/*+json)

    • breaking

      the ////////////////////////// request property type changed from string to number, and format from no format to double (media type: application/json-patch+json)

    • breaking

      the ////////////////////////// request property type changed from string to number, and format from no format to double (media type: application/json)

    • breaking

      the ////////////////////////// request property type changed from string to number, and format from no format to double (media type: text/json)

    • breaking

      the ////////////////////////// request property type changed from string to number, and format from no format to double (media type: application/*+json)

    • breaking

      the ////////////////////////// request property type changed from string to integer, and format from no format to int64 (media type: application/json-patch+json)

    • breaking

      the ////////////////////////// request property type changed from string to integer, and format from no format to int64 (media type: application/json)

    • breaking

      the ////////////////////////// request property type changed from string to integer, and format from no format to int64 (media type: text/json)

    • breaking

      the ////////////////////////// request property type changed from string to integer, and format from no format to int64 (media type: application/*+json)

    • breaking

      the //////////////// request property type changed from string to no type (media type: application/json-patch+json)

    • breaking

      the //////////////// request property type changed from string to no type (media type: application/json)

    • breaking

      the //////////////// request property type changed from string to no type (media type: application/*+json)

    • 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

      the //////////////// request property type was generalized from string to no type (media type: text/json)

    • 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