Create a flow definition

Example: Simple traffic allocation

This example uses simpleTraffic to expose 60 percent of guests to one variant and 40 percent to another:

{
  "traffic": {
    "type": "simpleTraffic",
    "weightingAlgorithm": "USER_DEFINED",
    "splits": [
      {
        "ref": "71206a12-b1b0-4baa-93ea-a0752a2762b0",
        "split": 60
      },
      {
        "ref": "ffe19d2a-b531-468d-a155-fedf757208e5",
        "split": 40
      }
    ]
  }
}

Example: Advanced traffic allocation

This example uses advancedTraffic for an experiment. Guests in buckets 1 to 11 will not be exposed to the experiment. Guests in buckets 12 to 55 will be exposed to one variant, while guests in buckets 56 to 120 will be exposed to another variant.

{
  "traffic": {
    "type": "advancedTraffic",
    "weightingAlgorithm": "USER_DEFINED",
    "modifiedAt": "2026-07-21T16:09:54.583Z",
    "allocationLow": 12,
    "allocationHigh": 120,
    "splits": [
      {
        "ref": "3e0c4419-5679-47e8-9d95-7f34b074af4b",
        "lowSplit": 12,
        "highSplit": 55
      },
      {
        "ref": "61705a82-a5d2-4a0f-920f-2c0990897b39",
        "lowSplit": 56,
        "highSplit": 120
      }
    ]
  }
}

Example: Country and operating system filters

To target guests in Denmark who use Windows, add two condition groups to filters.conditionGroups. Set unionType to "AND" on the second group so that both conditions must match:

• For the country template, set is to "is" and country(s) to "DK".
• For the operating_system template, set is to "is" and operating system(s) to "Windows".

Windows is an operating system, not a device type.

Each condition requires both templateFriendlyId and templateRevision. This example uses country template revision 5 and operating system template revision 9. Use the template revisions available in your environment.

Include the following fragment in the create request alongside the other required flow definition attributes:

{
  "filters": {
    "conditionGroups": [
      {
        "conditions": [
          {
            "templateFriendlyId": "country",
            "templateRevision": 5,
            "params": {
              "is": "is",
              "country(s)": "DK"
            }
          }
        ]
      },
      {
        "unionType": "AND",
        "conditions": [
          {
            "templateFriendlyId": "operating_system",
            "templateRevision": 9,
            "params": {
              "is": "is",
              "operating system(s)": "Windows"
            }
          }
        ]
      }
    ]
  }
}

These filters apply to the entire experiment or experience, not to an individual variant. For an experiment, use traffic.splits to configure the traffic distribution between variants separately. For example, a 50/50 split distributes eligible traffic between the control and the other variant.

When you retrieve the flow definition, each condition can include templateFriendlyId, templateRevision, and expression. In the Denmark and Windows example, the country expression checks request.params.geo.country, falling back to geolocation data in open web sessions when the request country is unavailable. The operating system expression checks the request's User-Agent header. The transpiledVariants array contains the combined condition expression in a conditionsTask for each variant.

For template-based filters such as these, provide templateFriendlyId, templateRevision, and params in the create request. You do not need to copy the condition's expression or the transpiledVariants array from a retrieved flow. Personalize resolves the template expressions and generates the transpiled variants.

Example: A control variant

This fragment defines the control variant used in the full experiment example. Use the same ref in the corresponding traffic.splits object.

{
  "variants": [
    {
      "ref": "e8c92a61-740f-4d35-a19b-3f062b85c947",
      "name": "Control",
      "isControl": true,
      "tasks": [
        {
          "implementation": "templateRenderTask",
          "input": {
            "inputType": "templateRenderTaskInput",
            "type": "application/json",
            "template": "{ \"message\": \"Hello\" }"
          }
        }
      ]
    }
  ]
}

Example: A start date

This fragment sets the earliest time the experiment can run:

{
  "schedule": {
    "type": "simpleSchedule",
    "startDate": "2026-10-29T00:00:00.000Z"
  }
}

Example: Sample size configuration

This fragment uses the default sample size parameters:

{
  "sampleSizeConfig": {
    "baseValue": 0.02,
    "minimumDetectableDifference": 0.2,
    "confidenceLevel": 0.95
  }
}