Experiment Evaluation API

Experiment Evaluation APIは、evaluation APIを使用することでリモート評価を通じてユーザーのバリアント割り当てデータを取得するか、flags APIを使用してローカル評価フラグをダウンロードします。

地域

認可

evaluation APIは、AuthorizationヘッダーにのApi-Keyプレフィックスを付与して設定されたデプロイメントキーを使用してリクエストを認証します。たとえば、Authorization: Api-Key <deployment_key>のようになります。

Evaluation API

GET /v1/vardata

Evaluation APIを使用すると、ユーザーのバリアント割り当てデータを取得できます。このAPIを呼び出すと、Amplitudeは[Experiment] Assignmentイベントを追跡します。

評価クエリパラメータ

評価ヘッダー

評価レスポンス

レスポンスボディは、フラグキーでキー化されたJSONオブジェクトです。各フラグキーの値は、ユーザーに割り当てられたバリアントです。各バリアントオブジェクトには次のフィールドが含まれています。

例えば：

{
  "my-experiment": {
    "key": "treatment",
    "payload": { "price": 99.99, "discount": "25%" },
    "expKey": "exp-1",
    "evaluationId": "224681772811_1760563672659_3681"
  }
  // ...
}

{}

評価レスポンスのステータスコード

評価の例

表のフィールドを設定し、[送信] を選択してブラウザでリクエストを作成するか、curlコマンドをコピーして自分でリクエストを実行してください。

1
2
3
curl --request GET \
  --url 'https://api.lab.amplitude.com/v1/vardata' \
  --header 'Authorization: Api-Key deployment_key'

Flags API

GET /v1/flags

Flags APIを使用すると、ローカル評価用のフラグ設定をダウンロードできます。Flags APIを使用して、クライアント側のローカル評価SDKをinitialFlagsでブートストラップしたり、エッジ環境などの外部フラグ設定ストレージを使用して評価を実行したりできます。

このAPIによって返されるデータモデルは、フラグと実験用の管理API形式とは異なります。 Flags API形式は評価をサポートしているため、管理API形式よりも冗長で人間が読みやすいものではありません。

フラグのクエリパラメータ

フラグヘッダー

フラグのレスポンス

Flags APIはオブジェクトのJSON配列を返します。ここにある各オブジェクトは、フラグまたは実験を表します。たとえば、これは単一のフラグを使用した基本的なレスポンスです。

[
  {
    "key": "example-flag",
    "metadata": {
      "deployed": true,
      "evaluationMode": "local",
      "flagType": "release",
      "flagVersion": 42
    },
    "segments": [
      {
        "metadata": {
          "segmentName": "All Other Users"
        },
        "variant": "off"
      }
    ],
    "variants": {
      "off": {
        "key": "off",
        "metadata": {
          "default": true
        }
      },
      "on": {
        "key": "on",
        "value": "on"
      }
    }
  }
]

フラグレスポンスのステータスコード