Contextual Bandit

string

required

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

name

string

required

owner

string

required

The userId of the owner (or raw owner name/email for legacy records)

tags

string[]

required

archived

boolean

required

status

enum<string>

required

Available options:

draft,

running,

stopped

trackingKey

string

required

hashAttribute

string

required

variations

object[]

required

Show child attributes

datasource

string

required

contextualBanditQueryId

string

required

seed

string

required

currentLeafWeights

object[]

required

Show child attributes

banditVersion

integer

required

Required range: x >= 0

contextualAttributes

string[]

required

minUsersPerLeaf

integer

required

maxLeaves

integer

required

holdoutPercent

number

required

Required range: 0 <= x <= 0.5

banditModelVersion

integer

required

Required range: x >= 0

description

string

project

string

ownerEmail

string

The email address of the owner, when the owner can be resolved to a known user.

dateStarted

string<date-time>

dateStopped

string<date-time>

coverage

number

Required range: 0 <= x <= 1

condition

string

savedGroups

object[]

Show child attributes

prerequisites

object[]

Show child attributes

variationWeights

object[]

Show child attributes

decisionMetric

string

scheduleValue

number

scheduleUnit

enum<string>

Available options:

days,

hours

burnInValue

number

burnInUnit

enum<string>

Available options:

days,

hours

conversionWindowValue

number | null

conversionWindowUnit

enum<string> | null

Available options:

hours,

days

stage

enum<string>

Available options:

explore,

exploit,

paused

stageDateStarted

string<date-time>

autoSnapshots

boolean

nextSnapshotAttempt

string<date-time>

{
  "id": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "owner": "<string>",
  "tags": [
    "<string>"
  ],
  "archived": true,
  "trackingKey": "<string>",
  "hashAttribute": "<string>",
  "variations": [
    {
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "datasource": "<string>",
  "contextualBanditQueryId": "<string>",
  "seed": "<string>",
  "currentLeafWeights": [
    {
      "leafId": 123,
      "condition": {},
      "weights": [
        {
          "variationId": "<string>",
          "weight": 123
        }
      ]
    }
  ],
  "banditVersion": 1,
  "contextualAttributes": [
    "<string>"
  ],
  "minUsersPerLeaf": 123,
  "maxLeaves": 123,
  "holdoutPercent": 0.25,
  "banditModelVersion": 1,
  "description": "<string>",
  "project": "<string>",
  "ownerEmail": "<string>",
  "dateStarted": "2023-11-07T05:31:56Z",
  "dateStopped": "2023-11-07T05:31:56Z",
  "coverage": 0.5,
  "condition": "<string>",
  "savedGroups": [
    {
      "ids": [
        "<string>"
      ]
    }
  ],
  "prerequisites": [
    {
      "id": "<string>",
      "condition": "<string>"
    }
  ],
  "variationWeights": [
    {
      "variationId": "<string>",
      "weight": 123
    }
  ],
  "decisionMetric": "<string>",
  "scheduleValue": 123,
  "burnInValue": 123,
  "conversionWindowValue": 123,
  "stageDateStarted": "2023-11-07T05:31:56Z",
  "autoSnapshots": true,
  "nextSnapshotAttempt": "2023-11-07T05:31:56Z"
}

Introduction

Endpoints

Models