3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

ExperimentSummary — openapi

Summary view of an experiment returned by the list endpoint. Does not include the variant / configuration payload; clients should call Get for the full payload.

Properties

Related Schemas

• ExperimentState

• ExperimentProductType

Complete Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Experiment ID.",
      "nullable": true
    },
    "name": {
      "type": "string",
      "description": "Experiment display name.",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "Experiment description.",
      "nullable": true
    },
    "createdTime": {
      "type": "string",
      "description": "UTC time the experiment was created.",
      "format": "date-time"
    },
    "lastUpdatedTime": {
      "type": "string",
      "description": "UTC time the experiment was last updated.",
      "nullable": true
    },
    "startedTime": {
      "type": "string",
      "description": "UTC time the experiment was started, if running.",
      "nullable": true
    },
    "stoppedTime": {
      "type": "string",
      "description": "UTC time the experiment was stopped, if completed/cancelled.",
      "nullable": true
    },
    "state": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExperimentState"
        }
      ],
      "description": "Lifecycle state.\n\nEXPERIMENT_STATE_DRAFT\n\nEXPERIMENT_STATE_SCHEDULED\n\nEXPERIMENT_STATE_RUNNING\n\nEXPERIMENT_STATE_COMPLETED\n\nEXPERIMENT_STATE_CANCELLED\n\nEXPERIMENT_STATE_DELETED",
      "x-enum-varnames": [
        "Draft",
        "Scheduled",
        "Running",
        "Completed",
        "Cancelled",
        "Deleted"
      ]
    },
    "createdBy": {
      "type": "string",
      "description": "User ID of the creator of the experiment.",
      "nullable": true
    },
    "experimentConfigKey": {
      "type": "string",
      "description": "Convenience field exposing the first config key referenced by the first variant\r\n(in-game-configs experiments only). Empty for matchmaking.",
      "nullable": true
    },
    "scheduledTime": {
      "type": "string",
      "description": "UTC time the experiment is scheduled to start, if scheduled.",
      "nullable": true
    },
    "durationSeconds": {
      "type": "integer",
      "description": "Planned experiment duration in whole seconds.",
      "format": "int64"
    },
    "productType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExperimentProductType"
        }
      ],
      "description": "Product type.\n\nEXPERIMENT_PRODUCT_TYPE_IN_GAME_CONFIGS\n\nEXPERIMENT_PRODUCT_TYPE_MATCHMAKING",
      "x-enum-varnames": [
        "InGameConfigs",
        "Matchmaking"
      ]
    }
  },
  "additionalProperties": false,
  "description": "Summary view of an experiment returned by the list endpoint. Does not include the variant /\r\nconfiguration payload; clients should call Get for the full payload."
}