Experiment Management API Mutexグループエンドポイント

名前	概要
List mutex groups	mutexグループとその設定の詳細のリストを表示します。
Get mutex group details	単一mutexグループの設定の詳細を取得します。
Edit a mutex group	mutexグループの名前、説明、またはアーカイブ状態を更新します。
Edit mutex group slots	mutexグループスロットの内容を更新します。
Create a mutex group	新しいmutexグループを作成します。

EUデータレジデンシー

このページの例では、デフォルトのベースURLを使用しています。https://experiment.amplitude.comプロジェクトでAmplitudeのEUデータセンターを使用している場合は、代わりにhttps://experiment.eu.amplitude.comを使用してください。詳細については、地域を参照してください。

List mutex groups

bash

GET https://experiment.amplitude.com/api/1/mutexes

mutexグループのリストを返します（構成の詳細を含む）。

クエリパラメータ

名前	概要
`limit`	返されるmutexグループの最大数。上限は1000です。
`cursor`	結果ページの開始位置となるオフセットです。

レスポンス

リクエストが成功すると、200 OKレスポンスと、レスポンス本文にJSONとしてエンコードされたmutexグループのリストが返されます。

curl --request GET \
--url 'https://experiment.amplitude.com/api/1/mutexes?limit=1000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'

Get mutex group details

bash

GET https://experiment.amplitude.com/api/1/mutexes/<id>

単一mutexグループの設定の詳細を返します。

パス変数

名前	タイプ	必須	概要
`id`	文字列	はい	mutexグループのID。

レスポンス

リクエストが成功すると、200 OKレスポンスとmutexグループの詳細を含むJSONオブジェクトが返されます。

curl --request GET \
    --url 'https://experiment.amplitude.com/api/1/mutexes/<id>' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

Edit a mutex group

bash

PATCH https://experiment.amplitude.com/api/1/mutexes/{id}

mutexグループの名前、説明、またはアーカイブ状態を更新します。

パス変数

名前	タイプ	必須	概要
`id`	文字列	はい	mutexグループのID。

リクエスト本文

名前	タイプ	必須	概要
`name`	文字列	いいえ	mutexグループ名。
`description`	文字列	いいえ	mutexグループの説明。
`archive`	ブール値	いいえ	mutexグループをアーカイブまたはアーカイブ解除します。`true`の場合、Amplitudeは他のすべての引数を無視し、mutexグループを削除済みとしてマークし、すべての子実験の親依存関係から削除します。

リクエスト例

json

{
  "name": "updated name",
  "description": "updated description"
}

レスポンス

リクエストに成功すると、200 OKレスポンスが返されます。

リクエスト

curl

curl --request PATCH \
    --url 'https://experiment.amplitude.com/api/1/mutexes/<id>' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"name": "updated name"}'

Edit mutex group slots

bash

PATCH https://experiment.amplitude.com/api/1/mutexes/{id}/slots/{slotIndex}

mutexグループスロットの内容を更新します。

パス変数

名前	タイプ	必須	概要
`id`	文字列	はい	mutexグループのID。
`slotIndex`	番号	はい	このmutexのスロットインデックス。

リクエスト本文

名前	タイプ	必須	概要
`experiments`	数値配列	いいえ	含める実験IDのリスト。
`holdouts`	数値配列	いいえ	含めるホールドアウトグループIDのリスト。
`individuals`	文字列配列	いいえ	含めるユーザーIDまたはデバイスIDのリスト。

リクエスト例

json

{
  "experiments": [123, 456],
  "individuals": ["x@amplitude.com", "y@amplitude.com", "abcde-12345"]
}

レスポンス

リクエストに成功すると、200 OKレスポンスが返されます。

リクエスト

curl

curl --request PATCH \
    --url 'https://experiment.amplitude.com/api/1/mutexes/<id>/slots/<slotIndex>' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"experiments": [123, 456]}'

Create a mutex group

bash

POST https://experiment.amplitude.com/api/1/mutexes

新しいmutexグループを作成します。

リクエスト本文

名前	タイプ	必須	概要
`projectId`	番号	はい	mutexグループのプロジェクトID。
`name`	文字列	はい	mutexグループ名。
`key`	文字列	いいえ	mutexグループキー。すべてのフラグ、実験、ホールドアウトグループ、mutexグループ間で一意である必要があります。Amplitudeはキーを指定しない場合にキーを生成します。
`description`	文字列	いいえ	mutexグループの説明。
`evaluationMode`	文字列	いいえ	mutexグループ評価モード。オプションは`local`または`remote`です。デフォルトは`remote`です。
`bucketingKey`	文字列	いいえ	ユーザーをバケットに分類するためのユーザープロパティ。デフォルトは`amplitude_id`です。
`bucketingSalt`	文字列	いいえ	mutexグループのバケットソルト。デフォルトではランダム化された文字列です。
`slots`	オブジェクト配列	はい	`slots`の配列。最大20スロット。順序は重要です。

スロット

slotsフィールドにはこれらのオブジェクトが含まれています。

名前	タイプ	必須	概要
`percentage`	番号	はい	このスロットへのトラフィックの割合。 1〜100の整数（両端を含む）です。すべてのスロット全体のパーセンテージの合計は100である必要があります。
`experiments`	文字列配列	いいえ	含める実験IDのリスト。
`holdouts`	数値配列	いいえ	含めるホールドアウトグループIDのリスト。
`individuals`	数値配列	いいえ	含めるユーザーIDまたはデバイスIDのリスト。

リクエスト例

json

{
  "projectId": "<projectId>",
  "name": "Example Mutex Group",
  "key": "example-mutex",
  "description": "An example mutex group",
  "evaluationMode": "remote",
  "slots": [
    {
      "percentage": 40,
      "experiments": [123],
      "holdouts": [456]
    },
    {
      "percentage": 60,
      "experiments": [789],
      "individuals": ["x@amplitude.com"]
    }
  ]
}

レスポンス

リクエストが成功すると、200 OKレスポンスと、mutexグループのIDおよびURLを含むJSONオブジェクトが返されます。

curl --request POST \
    --url 'https://experiment.amplitude.com/api/1/mutexes' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"projectId":"<projectId>","slots":[{"percentage":40},{"percentage":60}]}'

これは役に立ちましたか？