Experiment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/abmeter-ai/json-schema/abmeter-ai-experiment-schema.json",
  "title": "Experiment",
  "description": "A/B test configuration with variants and audience allocation",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/abmeter-ai-openapi.yml#/components/schemas/Experiment",
  "type": "object",
  "properties": {
    "slug": {
      "$ref": "#/$defs/Slug"
    },
    "hypothesis": {
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "space_slug": {
      "$ref": "#/$defs/Slug"
    },
    "state": {
      "type": "string",
      "enum": [
        "init",
        "running",
        "stopped",
        "archived"
      ],
      "readOnly": true
    },
    "allocation": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Percentage of space allocated to this experiment"
    },
    "primary_metric_slug": {
      "$ref": "#/$defs/Slug",
      "nullable": true,
      "description": "Slug of the primary metric to optimize for in this experiment"
    },
    "guardrail_metric_slugs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Slug"
      },
      "description": "Slugs of guardrail metrics to monitor for unexpected negative effects"
    },
    "audiences": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/RandomAudience"
      },
      "readOnly": true
    },
    "started_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "readOnly": true
    },
    "stopped_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "required": [
    "slug",
    "allocation"
  ],
  "$defs": {
    "RandomAudience": {
      "type": "object",
      "description": "Experiment-specific audience for random traffic allocation",
      "properties": {
        "slug": {
          "$ref": "#/$defs/Slug"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "enum": [
            "random"
          ],
          "description": "Type of audience (always random for experiment audiences)"
        },
        "percentage": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100,
          "description": "Percentage allocation for this audience"
        },
        "variant_slug": {
          "$ref": "#/$defs/Slug",
          "nullable": true,
          "description": "Variant assigned to this audience (null for control group)"
        }
      },
      "required": [
        "slug",
        "percentage"
      ]
    },
    "Slug": {
      "type": "string",
      "description": "Standardized identifier for entities used across the API. Recommended format: each entity type has its own prefix pattern followed by a short alphanumeric identifier (e.g., parameter-ab4c, space-main, audience-control)."
    }
  }
}