Experiment

Example Usage

import { Experiment } from "@vercel/sdk/models/flag.js";

let value: Experiment = {
  allocationUnit: "visitorId",
  primaryMetrics: [
    {
      name: "<value>",
      metricType: "percentage",
      metricUnit: "user",
      directionality: "decreaseIsGood",
    },
  ],
  status: "draft",
};

Fields

Field	Type	Required	Description
id	string	:heavy_minus_sign:	N/A
name	string	:heavy_minus_sign:	N/A
numVariants	number	:heavy_minus_sign:	N/A
surfaceArea	string	:heavy_minus_sign:	N/A
stickyRequirement	boolean	:heavy_minus_sign:	N/A
layer	string	:heavy_minus_sign:	N/A
guardrailMetrics	models.GuardrailMetrics[]	:heavy_minus_sign:	N/A
hypothesis	string	:heavy_minus_sign:	N/A
device	models.Device	:heavy_minus_sign:	N/A
controlVariantId	string	:heavy_minus_sign:	N/A
startedAt	number	:heavy_minus_sign:	N/A
endedAt	number	:heavy_minus_sign:	N/A
decision	string	:heavy_minus_sign:	N/A
decisionReason	string	:heavy_minus_sign:	N/A
duration	number	:heavy_minus_sign:	N/A
durationUnit	models.DurationUnit	:heavy_minus_sign:	N/A
allocationPercent	number	:heavy_minus_sign:	N/A
allocationUnit	models.AllocationUnit	:heavy_check_mark:	N/A
primaryMetrics	models.PrimaryMetrics[]	:heavy_check_mark:	N/A
status	models.FlagStatus	:heavy_check_mark:	N/A