フローの定義REST API

フロー定義REST APIフロー定義に対してCRUD操作を行うことを可能にします。フロー定義とは、ウェブ上のインタラクティブな実験や体験のことです。

フロー定義には以下の属性を使用します:

属性

種類

概要

例

name

ストリング

フローの定義の名前です。

"Alert bar"

friendlyId

ストリング

フロー定義の一意ID。

小文字の英数字文字とアンダースコアのみが許可されています。

"alert_bar_1"

type

文字列エヌム(大文字)

フローの定義の種類。

ウェブ実験や体験の場合は、この値を "INTERACTIVE_WEB_FLOW"に設定します。

インタラクティブな実験や体験の場合は、この値を "INTERACTIVE_API_FLOW"に設定します。

トリガーされた実験や体験の場合は、この値を "TRIGGERED_V3"に設定します。

以下のいずれかでなければなりません:

• "INTERACTIVE_WEB_FLOW"
• "INTERACTIVE_API_FLOW"
• "TRIGGERED_V3"

subtype

文字列エヌム(大文字)

流れのサブタイプ。

この値を "EXPERIMENT" または "EXPERIENCE"に設定します。

以下のいずれかでなければなりません:

• "EXPERIMENT"
• "EXPERIENCE"

status

文字列エヌム(大文字)

フロー定義の状況。

実験や体験を作成するときは、この値を "DRAFT"に設定してください。

以下のいずれかでなければなりません:

• "DRAFT"
• "PUBLISHING"
• "PRODUCTION"
• "SCHEDULED"
• "LIVE"
• "PAUSED"
• "COMPLETED"

channels

大文字文字列の配列(ENUM)

ユーザーがブランドと関わる接点です。

例えば、ウェブページの場合、チャネルは "WEB"です。モバイルアプリの画面では、チャネルは "MOBILE_APP"です。

すべての文字列は以下のいずれかでなければなりません:

• "CALL_CENTER"
• "EMAIL"
• "MOBILE_APP"
• "MOBILE_WEB"
• "PUSH_NOTIFICATION"
• "SMS"
• "WEB"

businessProcess

ストリング

ウェブやインタラクティブな実験や体験の場合は、この値を "interactive_v1"に設定します。

トリガーされた実験や体験の場合は、この値を "triggered_v1"に設定します。

• "interactive_v1"
• "triggered_v1"

variants

配列

同じ実験の異なるバージョンです。

体験のために、この値を空の配列 に設定します。

traffic

目的

実験の場合、このオブジェクトが各バリアントにどれだけの割合のゲストを曝露すべきかを決定します。

体験の場合、このオブジェクトがゲストの体験に触れるべき割合を決定します。

"mys3cr3tstr1ingforauth1!x"

schedule

目的

実験や体験が実行される時間枠。

"mys3cr3tstr1ingforauth1!x"

sampleSizeConfig

目的

主な目的を持つ実験では、このオブジェクトはA/B検定パラメータを定義します。これらのパラメータは検定が統計的有意性に達するために必要な最小サンプルサイズに影響を与えます。

"mys3cr3tstr1ingforauth1!x"

archived

ブール値

フロー定義のアーカイブステータス。

true, false

revisions

オブジェクトの配列

フロー定義の改訂版の配列。

"mys3cr3tstr1ingforauth1!x"

revision

整数

テンプレート改訂の連番番号。

2

trafficの目的:

属性

種類

概要

例

type

文字列エナム

実験のためのトラフィック割り当てタイプ。

体験としては、 "simpleTraffic" か "advancedTraffic"に設定してください。

以下のいずれかでなければなりません:

• "simpleTraffic"
• "advancedTraffic"

weightingAlgorithm

文字列エナム

実験中の各バリアントに与えられる重みを決定するアルゴリズム。

以下のいずれかでなければなりません:

• "MULTI_ARMED_BANDIT"
• "USER_DEFINED"

coupled

ブール値

この値は、実験が他の実験と結合しているかどうかを決定します。

カップリング実験では、ゲスト参照に基づいてすべてのゲストに恒久的なバケット番号が割り当てられます。

すべてのカップル実験において、ゲストのバケット番号は同じままです。

true, false

allocation

整数

最低 0。最大 100。

実験の場合は、この値を実験に曝露したいゲストの割合に設定します。

体験として、この値を 100に設定します。

100

splits

オブジェクトの配列

実験では、バリアント間でトラフィックをどのように分割するかを指定します。

各オブジェクトはバリアントを表します。各オブジェクトの ref はバリアント参照です。 split は、バリアントが受け取るべきトラフィックの割合を表す数値です。

体験のために、この値を空の配列 に設定します。

"mys3cr3tstr1ingforauth1!x"

以下は、ゲストの60%が別のバリアントに曝露される実験のsimpleTrafficトラフィックの例です:

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

} }

実験のadvancedTeafficトラフィックの例を紹介します。バケット1から11のゲストは実験に触れません。バケット12から55のゲストは1つのバリアントにさらされ、バケット56から120のゲストは別のバリアントに曝露されます。

{ "traffic": { "type": "advancedTraffic", "weightingAlgorithm": "USER_DEFINED", "modifiedAt": "2026-07-21T16:`09

} }

scheduleの目的:

属性

種類

概要

例

type

文字列エナム

フロースケジュールの種類。

この値を "simpleSchedule"に設定します。

"simpleSchedule"

startDate

文字列(ISO 8601)

流れが始まる最も早い時間です。

2026-07-04T11:46

endDate

任意

文字列(ISO 8601)

流れが流れる最後のタイミングです。

2026-07-22T12:00

sampleSizeConfigの目的:

属性

種類

概要

例

baseValue

番号

プライマリーゴールの予想されるコンバージョンゴール値。

デフォルトは 0.02です。

0.02

minimumDetectableDifference

番号

基準値に対して検出する最小変換目標差。

デフォルトは 0.2です。

0.2

confidenceLevel

番号

テスト前の必要な信頼レベルは完成とみなされます。

この値は、帰無仮説が真であれば、測定された差がランダムな変動によるものではないという組織の確信度を表しています。

デフォルトは 0.95です。

0.95