ROroblox
Experiments

Lists experiments for a universe.

Changed on

Pagination is offset-based (maxPageSize + skip). The response carries the page slice plus the unpaginated total matching the filters. Request includes optional pagination, search, and filters.

get/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:read

Path parameters

universeIdinteger required

Query parameters

maxPageSizeinteger
skipinteger
searchKeystring
stateFiltersExperimentState[]
sortOrder'SORT_ORDER_ASCENDING' | 'SORT_ORDER_DESCENDING'

Sort direction for list queries.

SORT_ORDER_ASCENDING

SORT_ORDER_DESCENDING

SORT_ORDER_ASCENDING

SORT_ORDER_DESCENDING

sortKey'LIST_EXPERIMENT_SORT_KEY_NAME' | 'LIST_EXPERIMENT_SORT_KEY_LAST_MODIFIED_TIME' | 'LIST_EXPERIMENT_SORT_KEY_START_TIME' | 'LIST_EXPERIMENT_SORT_KEY_RELEVANCE'

Key to sort an experiment list by.

LIST_EXPERIMENT_SORT_KEY_NAME

LIST_EXPERIMENT_SORT_KEY_LAST_MODIFIED_TIME

LIST_EXPERIMENT_SORT_KEY_START_TIME

LIST_EXPERIMENT_SORT_KEY_RELEVANCE

LIST_EXPERIMENT_SORT_KEY_NAME

LIST_EXPERIMENT_SORT_KEY_LAST_MODIFIED_TIME

LIST_EXPERIMENT_SORT_KEY_START_TIME

LIST_EXPERIMENT_SORT_KEY_RELEVANCE

productTypeFilter'EXPERIMENT_PRODUCT_TYPE_IN_GAME_CONFIGS' | 'EXPERIMENT_PRODUCT_TYPE_MATCHMAKING'

Type of product the experiment is targeting.

EXPERIMENT_PRODUCT_TYPE_IN_GAME_CONFIGS

EXPERIMENT_PRODUCT_TYPE_MATCHMAKING

EXPERIMENT_PRODUCT_TYPE_IN_GAME_CONFIGS

EXPERIMENT_PRODUCT_TYPE_MATCHMAKING

Response

OK

totalinteger

Total number of experiments for the universe matching the filters (independent of pagination).

Changes

  • bcfdc20689cdRevision changes
    • breaking

      for the query request parameter maxPageSize, the type changed from string to integer, and format from no format to int32

    • breaking

      for the query request parameter skip, the type changed from string to integer, and format from no format to int32

    • info

      for the query request parameter productTypeFilter, the type was generalized from string to no type

    • info

      for the query request parameter sortKey, the type was generalized from string to no type

    • info

      for the query request parameter sortOrder, the type was generalized from string to no type

  • 1d2042bb1a48Revision changes
    • info

      endpoint added