Flag programs: evaluate · StartupBuilder

Reference for Flag, one group of Flag programs.

Flag.evaluate

Evaluate returns the Variant a Flag assigns one unit, the same one every time, and records the Exposure with every option and its propensity. Verb page.

Text

do: return await $.Flag.evaluate(input)

Emits Flag.evaluated.

Inputs

Input	Type	Required	Description
`flag`	Flag	required	The Flag to evaluate, by key.
`unit`	`string`	required	The id of the Visitor, Customer, Contact, Conversation or request being assigned.
`default`	`string`		The Variant key returned when the Flag is off or the value may not be varied.

Returns

Output	Type	Required	Description
`variant`	Variant	required	The Variant assigned to the unit.
`exposure`	Exposure		The Exposure recorded; none in Mode try.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flag.evaluate({ flag: 'flag_1YJLhjTlfx', unit: 'Example unit' })"
  }
}

Flag.evaluateCopy Anchor Link

Flag.evaluate