実験を更新

ID で実験を部分的に更新します。指定したフィールドのみ更新されます。割り当てを指定すると、割り当てセット全体が置き換えられます。

PATCH https://{tenantDomain}/api/v2/experimentation/experiments/{id}

実験を更新します。

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/experiments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allocations": [
    {
      "is_control": true,
      "variation_id": "<string>",
      "is_fallback": true,
      "priority": 2,
      "segment_id": "<string>",
      "weight": 50
    }
  ],
  "description": "<string>",
  "name": "<string>"
}
'

200

{
  "allocations": [
    {
      "is_control": true,
      "is_fallback": true,
      "priority": 123,
      "segment_id": "<string>",
      "variation_id": "<string>",
      "weight": 123
    }
  ],
  "assignment_config": {
    "subject": "device"
  },
  "authentication_flow": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "feature_flag_id": "<string>",
  "id": "<string>",
  "is_valid": true,
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "ended_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

更新する実験の ID。

ボディ

application/jsonapplication/x-www-form-urlencoded

実験の部分更新。指定されたフィールドのみ更新されます。allocations を指定すると、allocations 一式全体が置き換えられます。

allocations · object[]

すべてのトラフィック割り当てを置き換えます。実験がアクティブな間は変更できません。

Minimum array length: 1

Show child attributes

assignment_config · object

ユーザーをバリエーションに割り当てる方法の設定

Show child attributes

description · string | null

実験の説明

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

name · string

実験のわかりやすい名前

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

レスポンス

200

application/json

実験が正常に更新されました。

allocation_strategy · enum<string> · 必須

利用可能なオプション: percentage, segment

allocations · object[] · 必須

Show child attributes

assignment_config · object · 必須

Show child attributes

authentication_flow · string · 必須

created_at · string<date-time> · 必須

feature_flag_id · string · 必須

id · string · 必須

Pattern: ^exp_[A-HJ-NP-Za-km-z1-9]+$

is_valid · boolean · 必須

name · string · 必須

status · enum<string> · 必須

status で絞り込みます。完全一致。

利用可能なオプション: draft, active, paused, completed, archived

updated_at · string<date-time> · 必須

description · string

ended_at · string<date-time>

started_at · string<date-time>