2 min read

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

VariantMeta — openapi

Metadata shared by every experiment variant.

Properties

NameTypeRequiredDescription
variantIdstringfalseUnique identifier for the variant. Only assigned once the experiment starts running; empty or null for draft variants.
labelstringfalseHuman-readable label for the variant, e.g. Control, Treatment A. Non-empty, at most 50 characters; must start with a letter and contain only letters, digits, spaces, underscores, or hyphens.
isBaselinebooleanfalseTrue iff this variant is the baseline. Exactly one variant must be the baseline.
weightintegerfalseRelative traffic weight for this variant. The platform normalizes across all variants, so weights do not have to sum to 100.

Complete Schema

{
  "type": "object",
  "properties": {
    "variantId": {
      "type": "string",
      "description": "Unique identifier for the variant. Only assigned once the experiment starts running;\r\nempty or null for draft variants.",
      "nullable": true
    },
    "label": {
      "type": "string",
      "description": "Human-readable label for the variant, e.g. `Control`, `Treatment A`. Non-empty,\r\nat most 50 characters; must start with a letter and contain only letters, digits, spaces,\r\nunderscores, or hyphens.",
      "nullable": true
    },
    "isBaseline": {
      "type": "boolean",
      "description": "True iff this variant is the baseline. Exactly one variant must be the baseline."
    },
    "weight": {
      "type": "integer",
      "description": "Relative traffic weight for this variant. The platform normalizes across all variants,\r\nso weights do not have to sum to 100.",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Metadata shared by every experiment variant."
}