Skip to content

Flag

A Flag is a switch, evaluated per Visitor, Customer, or request, that selects which copy or behavior they get.

Properties

PropertyTypeRequiredDescription
keystringrequiredThe name code reads.
rulesjsonWho gets which value, including percentage splits.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/flags/flag_1",
  "$type": "Flag",
  "key": "new-checkout",
  "rules": {}
}

Relationships

Verbs

  1. createCreates a Flag.
    POST /{namespace}/flagsdoFlag.created
  2. getReturns one Flag by id.
    GET /{namespace}/flags/{id}readNo Event
  3. listReturns Flags, newest first, one page at a time.
    GET /{namespace}/flagsreadNo Event
  4. updateChanges the given properties of a Flag.
    PATCH /{namespace}/flags/{id}doFlag.updated
  5. deleteDeletes a Flag; its history is kept.
    DELETE /{namespace}/flags/{id}doFlag.deleted
  6. evaluateEvaluate returns the Variant a Flag assigns one unit, the same one every time, and records the Exposure with every option and its propensity.
    POST /{namespace}/flags/{flag}/evaluatedoFlag.evaluated

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Flag.createYesYesYesNo
Flag.getYesYesYesYes
Flag.listYesYesYesYes
Flag.updateYesYesYesNo
Flag.deleteYesYesYesNo
Flag.evaluateYesYesYesNo

Call it

Text
Evaluate the latest flag.

Example

The Flag pricing-page-v2 shows the new pricing Page to 50% of Visitors and the prior Page to the rest.