このページでは

ダッシュボード REST API

地域

ベースURLは、プロジェクトのデータのレジデンシーによって異なります。このページ内のすべての例では、プロジェクトがAmplitudeのEUデータセンターを利用している場合を除き、デフォルトのベースURLを使用してください。EUデータセンターを利用している場合は、この表に記載されているEU用のベースURLを使用してください。

リクエストはhttps://amplitude.com（デフォルト）またはhttps://analytics.eu.amplitude.com（EU）に送信されます。https://analytics.amplitude.comのホスト名はアナリティクスウェブアプリ（ブラウザーUI）です。RESTリクエストにはanalytics.amplitude.comではなく、この表に記載されているホストを使用してください。

データのレジデンシーベースURL
デフォルトhttps://amplitude.com
欧州連合https://analytics.eu.amplitude.com

考慮事項

  • イベントタイプ、イベントプロパティ、およびユーザープロパティ名に含まれる特殊文字は、URLエンコードしてください。たとえば、Play%20SongとしてPlay Songをエンコードします。W3Schools のエンコーディングリファレンスを参照してください。
  • いくつかの例では、バックスラッシュ構文を使用してcURL内の文字をエスケープします。cURLを使用していない場合は、リクエストをバックスラッシュエスケープ文字でエンコードしないでください。
  • ダッシュボードのREST APIのタイムゾーンは、Amplitudeプロジェクトのタイムゾーンと一致します。

レート制限

各エンドポイントには同時実行の制限とレート制限があります。 同時実行数の制限により、同時に実行できるリクエストの数が制限されます。 レート制限により、1時間あたりのクエリの合計数が制限されます。これらの制限を超えると、429エラーが返されます。制限はプロジェクトごとに設定されており、429 エラーにはどの制限を超過したかに関する情報が含まれています。

同時実行の制限：コホートのダウンロードを含むすべてのAmplitude REST APIエンドポイントに対して、最大5件のリクエストを同時に実行できます。

ユーザーアクティビティとユーザー検索の制限

ユーザーアクティビティとユーザー検索のエンドポイントには異なる制限があります。
  • 同時実行制限:これらのエンドポイントに対して最大10件の同時リクエストを実行できます。
  • レート制限:これらのエンドポイントに対して1時間あたり最大360件のクエリを実行できます。

エンドポイントコスト

各エンドポイントは、_クエリごとのコスト_に基づくレート制限モデルを使用します。コストとは金銭的価値を指すものではありません。コストとは、レート制限とAPIの使用制限のことです。この方法により、すべてのクエリに対して同じAPI可用性を実現できます。Amplitudeは次の数式を使用してレートコストを計算します：

cost = (# of days) * (# of conditions) * (cost for the query type)

Amplitudeは、各変数を次のように算出します。

  • 日数：クエリに含まれる日数です。
  • 条件数：チャートに適用されたセグメント数に、それらのセグメント内に含まれる条件数を加えた値です。各グループ化は4セグメントとしてカウントされます。

セグメントと条件

  • セグメントは比較グループです。 詳細については、「ユーザーセグメントを追加する」を参照してください。
  • 条件は最上位レベルのフィルタを表します。 コホート、WHERE、および「誰が実行/実行したか」はAmplitudeの条件です。 イベントフィルターは、APIコストの条件としてカウントされません。

チャートタイプごとにコストが異なります。ここに記載されていないエンドポイントの場合、コストは 1 です。これらのエンドポイントの制限は、クエリあたりのコストで測定され、次のとおりです。

  • 同時実行制限: 5 分以内に最大 1,000 のコストが発生します。

  • レート制限：1時間あたりのコストは最大108,000です。

  • イベントセグメンテーション：左側のモジュール内のイベント数に等しい。いずれかのイベントにgroup byがある場合は、group byとイベントごとにコスト4を加算します。
  • ファネル分析：ファネル内のイベント数に 2 を掛け合わせた値です。いずれかのイベントにgroup byがある場合は、group byとイベントごとにコスト4を加算します。
  • リテンション分析：このチャートのコストは 8 です。
  • ユーザーセッション：このチャートのコストは 4 です。

共有クエリパラメータ

これらのクエリパラメータは、複数のダッシュボードREST APIエンドポイント間で共有されます。

  • Amplitudeに組み込まれるプロパティの場合、有効な値はversion、country、city、region、DMA、language、platform、os、device、device_type、start_version、payingです。
  • カスタムユーザープロパティの場合、キーをgp:nameとしてフォーマットします。
パラメータ概要
eオプションのプロパティフィルタまたはグループ化基準を持つ完全なイベント。イベントは、イベント形式で説明されているようにJSONオブジェクトとして表現されます。
sセグメントの定義。 必要に応じて任意の数を指定できます。セグメントは JSON 配列として表現されます。ここで各要素は、セグメント定義で説明されているフィルタ条件に対応する JSON オブジェクトです。
gグループ化に使用するプロパティです。例：platform。セグメントが 1 つしか存在しない場合にのみ使用できます。 制限：2個

イベント形式

イベント パラメータは次のキーを受け入れます。

キー必須概要
event_typeはいイベントの種類。 カスタムイベントの場合、名前の先頭にce:を付けます（例：ce:name）。「[Amplitude] Any Active Event」の場合は、_activeを使用します。「[Amplitude] Any Event」の場合は _all を使用します。 「[Amplitude] Revenue」には revenue_amount を使用します。 「[Amplitude] Revenue（Verified）」には、verified_revenueを使用してください。「[Amplitude] Revenue（未確認）」については、unverified_revenue を使用してください。
filtersいいえプロパティフィルタのリスト。 各フィルタはJSONオブジェクトです。フィルタオブジェクトのキーを参照してください。
group_byいいえグループ化基準とするプロパティのリスト（最大2つ）。各グループ別は、type（eventまたはuser）とvalue（プロパティ名）を含むJSONオブジェクトです。

フィルターオブジェクトのキー

キー必須概要
subprop_typeはいeventまたはuserのいずれかで、イベントまたはユーザープロパティを指定します。
subprop_keyはいフィルタリング対象となるプロパティの名前です。 Amplitude以外のカスタムユーザープロパティの場合、ユーザープロパティ名の先頭にgp:を付けます。gp:プレフィックスはイベントプロパティに必要ありません。
subprop_opはいフィルタ演算子。 is、is not、contains、does not contain、less、less or equal、greater、greater or equal、set is、またはset is notのいずれかです。
subprop_valueはいイベントプロパティをフィルタリングするための値のリスト。

イベント形式の例

json
{
  "event_type": "CompletedProfile",
  "filters": [
    {
      "subprop_type": "event",
      "subprop_key": "EmailVerified",
      "subprop_op": "is",
      "subprop_value": ["true"]
    },
    {
      "subprop_type": "user",
      "subprop_key": "gp:SignUpDate",
      "subprop_op": "is",
      "subprop_value": ["2021-08-18"]
    }
  ],
  "group_by": [
    {
      "type": "user",
      "value": "platform"
    }
  ]
}

セグメント定義

セグメントは、ユーザーの属性や行動に基づいてユーザーをフィルタリングします。 各セグメントはJSONオブジェクトです。

キー必須概要
propはいフィルタリング対象となるプロパティの名前です。 行動コホートの場合、プロパティ名はuserdata_cohort.です。例: s=\[\{"prop":"userdata_cohort","op":"is","values":\["XYXxxzz"\]\}\]。ここで、XYXxxzz は行動コホートの URL からの識別子です (https://analytics.amplitude.com/org_name/cohort/XYXxxzz) 。
opはいフィルタ演算子。 is、is not、contains、does not contain、less、less or equal、greater、greater or equal、set is、またはset is notのいずれかです。
valuesはいセグメントをフィルタリングするための文字列のリストです。 コホートごとにセグメント化する場合、値はコホート ID であり、ウェブアプリ内のコホートの URL に含まれています (例: 5mjbq8w)。
typeいいえ「誰が実行したか」フィルタを使用して、イベントの実行状況に基づいてユーザーをセグメント化する場合は、"event"に設定します。
event_typeいいえ「誰が実行したか」フィルタを使用する場合にフィルタリング対象となるイベント。 typeが"event"の場合には必須です。
filtersいいえ「誰が実行したか」フィルタを使用する場合のイベントプロパティフィルタ。フィルタオブジェクトの配列です。
valueいいえ「誰が実行したか」フィルタのカウントしきい値。 time_typeおよびtime_valueと一緒に使用します。
time_typeいいえ「誰が実行したか」フィルタの時間ウィンドウの種類です。"forEachInterval"、"currentInterval" または "allTime" のいずれかです。
time_valueいいえtime_typeが"forEachInterval"に等しい場合のタイムウィンドウの日数。

セグメント定義の例

ユーザープロパティフィルタ

プロパティ値でユーザーをフィルタリングします。

json
[
  {
    "prop": "version",
    "op": "contains",
    "values": ["1.0", "2.0"]
  },
  {
    "prop": "gp:gender",
    "op": "is",
    "values": ["female"]
  }
]

「誰が実行したか」フィルタ

特定のイベントを実行したユーザーをフィルタリングします。 この例では、過去30日間に少なくとも1回signup - end signupイベントを実行したユーザーをフィルタリングします。

json
[
  {
    "op": ">=",
    "type": "event",
    "event_type": "signup - end signup",
    "filters": [],
    "value": 0,
    "time_type": "forEachInterval",
    "time_value": 30
  }
]

複数のフィルターを組み合わせることができます。 この例では、signup - end signupイベントを1回以上実行した米国のユーザをフィルタリングします。

json
[
  {
    "prop": "country",
    "op": "is",
    "values": ["United States"]
  },
  {
    "op": ">=",
    "type": "event",
    "event_type": "signup - end signup",
    "filters": [],
    "value": 1,
    "time_type": "allTime"
  }
]

データテーブルのエクスポート

ダッシュボードのREST APIを使用して、データテーブルからデータをエクスポートできます。任意のデータテーブル チャートタイプをクエリします。クエリに開始日や終了日を含めないでください。

既存のチャートから結果を取得する

保存されたチャートからチャート ID ごとに任意の JSON 結果を取得します。 GET https://amplitude.com/api/3/chart/chart_id/csv

curl --location --request GET 'https://amplitude.com/api/3/chart/:chart_id/csv' \
-u '{api_key}:{secret_key}'

パス変数

名前概要
chart_id必須です。 チャートの ID。 ウェブアプリ内のチャートの URL からチャート ID を取得します。 たとえば、この URL abc123の場合:https://analytics.amplitude.com/demo/chart/abc123

レスポンス

レスポンスは、チャートのタイプによって異なります。

アクティブユーザー数と新規ユーザー数を取得

アクティブまたは新規ユーザーの数を取得します。

GET https://amplitude.com/api/2/users

curl --location --request GET 'https://amplitude.com/api/2/users?start=STARTDATE&end=ENDDATE' \
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
mオプションです。必要な集計件数に応じて、newまたはactiveのいずれかを指定します。デフォルトはactiveです。
iオプションです。毎日、毎週、毎月のカウントにはそれぞれ1、7、または30のいずれかを指定します。 デフォルトは1です。
sオプションです。セグメントの定義。 デフォルトは「なし」です。共有クエリパラメータで定義されています。
gオプションです。グループ化基準となるプロパティ。 デフォルトは「なし」です。共有クエリパラメータで定義されています。

レスポンス

レスポンスは次のスキーマを持つJSONオブジェクトです。

属性概要
seriesseriesMetaの順序に対応した、各グループごとに1要素を持つ配列です。各要素は、xValues内の各日付のメトリック値を含む配列です。
seriesMeta各セグメントに対応するラベルの配列です。
xValues指定した期間内の各日付に対応する、YYYY-MM-DD形式の日付文字列の配列です。
json
{
  "data": {
    "series": [
      [46109, 47542],
      [42845, 42626]
    ],
    "seriesMeta": ["United States", "Canada"],
    "xValues": ["2017-08-14", "2017-08-15"]
  }
}

セッション時間分布を取得する

指定した期間内における、あらかじめ定義された各セッション長（バケット）ごとのセッション数を取得します。

GET https://amplitude.com/api/2/sessions/length

curl --location --request GET 'https://amplitude.com/api/2/sessions/length?start=STARTDATE&end=ENDDATE'
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
timeHistogramConfigBinTimeUnitオプションです。バケットサイズの時間単位です。 有効な値は、hours、minutesおよびsecondsです。
timeHistogramConfigBinMinオプションです。バケット化の最小値、数値。 たとえば、0のようになります。
timeHistogramConfigBinMaxオプションです。バケット化に使用する最大値を数値で指定します。たとえば、600のようになります。
timeHistogramConfigBinSizeオプションです。各バケットのサイズを数値で表します。 たとえば、60のようになります。

timeHistogramConfigBin 形式

カスタムビニングを使用するには、timeHistogramConfigBinMin、timeHistogramConfigBinMax、およびtimeHistogramConfigBinTimeUnitを指定します。timeHistogramConfigBinSizeが指定されていない場合、Amplitudeは最適なビンサイズを自動的に決定します。たとえば、timeHistogramConfigBinMin=0、timeHistogramConfigBinMax=10、およびtimeHistogramConfigBinTimeUnit=minutesを指定した場合でも、最終的なビン数やビン境界は保証されません。timeHistogramConfigBinSize=1を指定した場合、10個のビンが作成され、各ビンのサイズは1分に相当します。

timeHistogramConfigBinパラメータが無効または欠落している場合、Amplitudeは直帰率などの動作を考慮したデフォルトのビンを使用します。 デフォルトのビン（単位：ミリ秒）は[0, 3000), [3000, 10,000), [10,000, 30,000), [30,000, 60,000), [60,000, 180,000), [180,000, 600,000), [600,000, 1,800,000), [1,800,000, 3,600,000), [3,600,000, 86,400,000)です。

セッション長の最大値は1日（86,400,000ミリ秒）です。

レスポンス

レスポンスは次のスキーマを持つJSONオブジェクトです。

属性概要
series各バケットに対応するセッション数を格納した配列を1つ含む配列です。
xValues[bucketStartInSeconds]s-[bucketEndInSeconds]sの形式で表される、セッション時間の区間文字列（バケット）の配列です。
json
{
  "data": {
    "series": [
      [0, 120408, 2261, 6984, 10778, 54529, 210614, 336605, 196235, 54148]
    ],
    "xValues": [
      "0s-60s",
      "60s-120s",
      "120s-180s",
      "180s-240s",
      "240s-300s",
      "300s-360s",
      "360s-420s",
      "420s-480s",
      "480s-540s",
      "540s-600s"
    ]
  }
}

平均セッション時間を取得する

GET https://amplitude.com/api/2/sessions/average

指定した日付範囲内の各日の平均セッション時間（秒単位）を取得します。

curl --location --request GET 'https://amplitude.com/api/2/sessions/average?start=20210601&end=20210630' \
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221004のようになります。

レスポンス

次のスキーマを持つ JSON オブジェクトを返します。

属性概要
series1つのアレイからなるアレイで、1日ごとの平均セッション時間があります。
seriesMeta各セグメントに対応するラベルの配列です。
segmentIndexセグメントのインデックス。チャートコントロールパネルの右側モジュールでのセグメントの位置を参照します。
xValues指定した期間内の各日付に対応する、YYYY-MM-DD形式の日付文字列の配列です。
json
{
  "data": {
    "series": [[1204.0238276716443, 1197.4160169086904]],
    "seriesMeta": [{ "segmentIndex": 0 }],
    "xValues": ["2017-08-14", "2017-08-15"]
  }
}

ユーザーあたりの平均セッション数を取得

GET https://amplitude.com/api/2/sessions/peruser

指定した日付範囲におけるユーザーごとの各日の平均セッション数を取得します。

curl --location --request GET 'https://amplitude.com/api/2/sessions/peruser?start=&end=' \
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221004のようになります。

レスポンス

次のスキーマを持つ JSON オブジェクトを返します。

属性概要
series各日付における、ユーザー1人あたりの平均セッション数（浮動小数点数）を格納した配列を1つ含む配列です。
seriesMeta各セグメントに対応するラベルの配列です。
segmentIndexセグメントのインデックス。チャートコントロールパネルの右側モジュールでのセグメントの位置を参照します。
xValues指定した期間内の各日付に対応する、YYYY-MM-DD形式の日付文字列の配列です。
json
{
  "data": {
    "series": [[3.624536794878406, 3.6232302614435854]],
    "seriesMeta": [{ "segmentIndex": 0 }],
    "xValues": ["2017-08-14", "2017-08-15"]
  }
}

ユーザー構成

指定した日付範囲内のユーザープロパティ値全体でのユーザー分布を取得します。

GET https://amplitude.com/api/2/composition

curl --location --request GET 'https://amplitude.com/api/2/composition?start=STARTDATE&end=ENDDATE&p=PROPERTY' \
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
p必須です。 構成を取得するためのプロパティ。Amplitudeに組み込まれるプロパティの場合、有効な値はversion、country、city、region、DMA、language、platform、os、device、start_version、payingです。カスタム定義のユーザープロパティの場合、キーを gp:name としてフォーマットします。

レスポンス

次のスキーマを持つ JSON オブジェクトを返します。

属性概要
series指定された日付範囲内で対応するプロパティ値を持つユニークユーザーの数を含む 1 要素の配列。
seriesLabelsチャートに表示されるユーザーのプロパティ。
xValues選択したプロパティが取ることができる値の配列です。
json
{
  "data": {
    "series": [[69643, 47419, 38087, 19064]],
    "seriesLabels": ["version"],
    "xValues": ["1.0", "(none)", "1.1", "0.2"]
  }
}

イベントリストを取得する

今週のイベント一覧と、それぞれの合計数、ユニークユーザー数、および% DAU（日次アクティブユーザー）を取得します。

このエンドポイントは、可視的なイベントを返します。 非表示イベントは API から返されません。

GET https://amplitude.com/api/2/events/list

curl --location --request GET 'https://amplitude.com/api/2/events/list' \
-u '{api-key}:{secret-key}'

レスポンス

次のスキーマを持つ JSON オブジェクトを返します。

属性概要
non_activeイベントが非アクティブにマークされているかどうか。
value生データ内のイベントの名前。
totalsこのイベントが今週発生した総回数です。
deletedイベントが削除されているかどうか。
flow_hiddenイベントがパスファインダーまたはパスファインダーユーザーから非表示になっているかどうか。
hiddenイベントが非表示になっているかどうか。
displayイベントの表示名。
json
{
    "data": [
        {
            "non_active": false,
            "value": "Add Content to Cart",
            "totals": 1505645,
            "deleted": false,
            "flow_hidden": false,
            "hidden": false,
            "display": "Add Content to Cart"
        },
        {
            "non_active": false,
            "value": "Add Friends",
            "totals": 193167,
            "deleted": false,
            "flow_hidden": false,
            "hidden": false,
            "display": "Add Friends"
        }
    ]
    ...
}

イベントセグメンテーション

セグメンテーションを使用してイベントのメトリクスを取得します。

curl --location --request GET 'https://amplitude.com/api/2/events/segmentation?e={"event_type":"YOUR%20EVENT"}&start=STARTDATE&end=DATE' \
-u '{api-key}:{secret-key}'

イベントタイプ、イベントプロパティ、およびユーザープロパティ名に含まれる特殊文字は、URLエンコードしてください。たとえば、Play Song を Play%20Song としてエンコードします。

クエリパラメータ

名前概要
e必須です。 最大 2 つまで含めます。 完全なイベントです。 イベント形式を参照してください。 2つ目のイベントについてクエリを行うには、パラメータe2を使用します。
mオプションです。プロパティを使用しないメトリクス：uniques、totals、pct_dau、またはaverage。デフォルトはuniquesです。 プロパティベースのメトリクス：histogram、sums、またはvalue_avg。プロパティベースのメトリクスを使用する場合は、パラメータeに有効なグループ別（group by）の値を指定してください。カスタム数式の場合：formula（このメトリックは最大2つのイベントをサポートしています。2つ目のイベントはe2パラメータを使用する必要があります）。
nオプションです。ユーザータイプ：anyまたはactive。
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
iオプションです。リアルタイム、時間単位、毎日、毎週、毎月のカウントについては、それぞれ-300000、-3600000、1、7、または30に設定します。デフォルトは1です。リアルタイムセグメンテーションは最大2日間のデータを表示し、時間ごとのセグメンテーションは最大7日間のデータを表示し、毎日は最大365日間のデータを表示します。
sオプションです。セグメント定義（デフォルト：なし）。「共有クエリパラメータ」を参照してください。
gオプションです。最大 2 つまで含めます。 グループ別基準となるプロパティの名前。デフォルトは「なし」です。Amplitude以外のカスタムユーザープロパティの場合、ユーザープロパティ名の先頭にgp:を付けます。たとえば、countryまたはgp:utm_campaignです。2 つ目のプロパティを照会するには、パラメータ g2 を使用します。
limitオプションです。返されるグループ化値の数（デフォルト値：100）。上限は1000です。
formulaオプションです。mがformulaに設定されている場合は必須です。 カスタム数式メトリックの場合は、ここに数式を渡します (例: UNIQUES(A)/UNIQUES(B))。
rollingWindowオプションです。ローリングウィンドウを使用するには必須です。 ローリングウィンドウを計算するには、日数、週数、または月数を渡します。
rollingAverageオプションです。ローリング平均を使用することが必須です。 ローリング平均を計算するには、日数、週数、または月数を指定します。

レスポンス

属性概要
seriesseriesLabelsの順序に対応した、各グループごとに1要素を持つ配列です。各要素は、xValues内の各日付のメトリック値を含む配列です。
seriesLabelsラベルの配列。各グループに1つずつあります。
seriesCollapsedseriesLabelsの順序に対応した、各グループごとに1要素を持つ配列です。各要素はイベントセグメンテーションにおける棒チャートの値であり、一定期間のユニークユーザーの総数を表します。
xValues指定した期間内の各日付に対応する、YYYY-MM-DD形式の日付文字列の配列です。
json
{
    "data": {
        "series": [
            [273333], [190351]
        ],
        "seriesLabels": ["United States", "Germany"],
        "seriesCollapsed": [
            [
                {"value": 273333}
            ],
            [
                {"value": 190351}
            ],
        "xValues": ["2014-10-01", "2014-10-02"]
    }
}

ファネル分析

ファネルの離脱率およびコンバージョン率を取得します。

GET https://amplitude.com/api/2/funnels

curl --location -g --request GET 'https://amplitude.com/api/2/funnels?e={"event_type":"EVENT_1"}&e={"event_type":"EVENT_2"}&start=STARTDATE&end=ENDDATE'
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
e必須です。 ファネル内の各ステップに対するフルイベントです。 イベント形式を参照してください。
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
modeオプションです。ファネルを実行するモード：指定された順序でイベントを実行した場合はordered、イベントの順序を問わない場合はunordered、指定された順序でイベントを実行し、かつその間に他のイベントが存在しない場合はsequential。 デフォルトはorderedです。
nオプションです。newまたは activeのいずれかを使用して、ファネル内で考慮すべきユーザーのセットを指定します。 デフォルトはactiveです。
iオプションです。リアルタイム、時間単位、毎日、毎週、毎月のカウントについては、それぞれ-300000、-3600000、1、7、または30に設定します。デフォルトは1です。リアルタイムセグメンテーションは最大2日間のデータを表示し、時間ごとのセグメンテーションは最大7日間のデータを表示し、毎日は最大365日間のデータを表示します。
sオプションです。セグメントの定義。 デフォルトは「なし」です。「共有クエリパラメータ」を参照してください。
gオプションです。制限：1グループ別基準となるプロパティの名前。デフォルトは「なし」です。Amplitude以外のカスタムユーザープロパティの場合、ユーザープロパティ名の先頭にgp:を付けます。たとえば、countryまたはgp:utm_campaignです。
csオプションです。コンバージョンウィンドウ（秒単位）。デフォルト値は 2,592,000（30日）です。unorderedモードでは、コンバージョンウィンドウは最も近い日単位に切り捨てられます。
limitオプションです。返された Group By 値の数。 デフォルトは100です。最大値は1000です。

レスポンス

応答には、グループごとに1つの要素を持つ配列が含まれます。各要素には次のフィールドがあります。

フィールド概要
metaラベルの配列。各セグメントに 1 つずつあります。 segmentIndexを含みます。これは、チャートコントロールパネルの右側モジュールにあるセグメントのインデックスです。
stepTransTimeDistribution各ステップのヒストグラムデータは、ユーザーがそのステップを完了するのにどれくらい時間がかかったかを示しています。
stepPrevStepCountDistributionユーザーが前のステップを実行した回数を示す各ステップのヒストグラムデータ。
bins1つのヒストグラムバケットのデータです。startおよびendはヒストグラムビンの境界をマークします。bin_distには、そのビンのユーザー数、カウント数、またはpropsumが含まれています。
dayMedianTransTimesステップ間の日ごとの移行時間の中央値。 series（グループごとに1要素を持つ配列で、各要素はxValues内の各日における遷移時間の中央値（ミリ秒単位）の配列）、xValues（YYYY-MM-DD形式の日付文字列）、およびformattedXValues（Month DD形式の日付文字列）を含みます。
dayAvgTransTimesステップ間の日ごとの平均移行時間。series（グループごとに1要素を持つ配列で、各要素はxValues内の各期間における平均遷移時間（ミリ秒単位）の配列）、xValues（YYYY-MM-DD形式の日付文字列）、およびformattedXValues（Month DD形式の日付文字列）を含みます。
stepByStepファネルステップごとに要素が1つある配列で、前のステップからそのステップを完了したユーザーの割合を示します。
medianTransTimesファネルステップごとに要素が1つある配列で、ステップ間の移行時間の中央値をミリ秒単位で示します。
cumulativeファネルステップごとに要素が 1 つある配列で、そのステップを完了したユーザー全体の割合を示します。
cumulativeRawファネルの各ステップに対して、そのステップを完了したユーザー数を示す配列です。
avgTransTimesファネルステップごとに要素が 1 つある配列で、ステップ間の平均遷移時間をミリ秒単位で示します。
dayFunnels各ファネルのステップを完了したユーザーの数を1日ごとに表示します。 series（グループごとに1要素を持つ配列で、各要素はxValues内の各期間におけるユーザー数の配列）、xValues（YYYY-MM-DD形式の日付文字列）、およびformattedXValues（Month DD形式の日付文字列）を含みます。
eventsファネル内の各イベントのラベル。
json
{
  "data": [
    {
      "meta": { "segmentIndex": 0 },
      "dayMedianTransTimes": {
        "series": [
          [0, 165548, 264380],
          [0, 164767, 269444]
        ],
        "xValues": ["2017-08-14", "2017-08-15"],
        "formattedXValues": ["Aug 14", "Aug 15"]
      },
      "dayAvgTransTimes": {
        "series": [
          [0, 2294365, 5730478],
          [0, 2268879, 5700436]
        ],
        "xValues": ["2017-08-14", "2017-08-15"],
        "formattedXValues": ["Aug 14", "Aug 15"]
      },
      "stepByStep": [1.0, 0.9915120144246691, 0.9741139357951383],
      "medianTransTimes": [0, 166444, 270194],
      "cumulative": [1.0, 0.9915120144246691, 0.9658456707593803],
      "cumulativeRaw": [163054, 161670, 157485],
      "avgTransTimes": [0, 2175406, 5607243],
      "dayFunnels": {
        "series": [
          [125259, 123716, 118636],
          [126964, 125373, 119986]
        ],
        "xValues": ["2017-08-14", "2017-08-15"],
        "formattedXValues": ["Aug 14", "Aug 15"]
      },
      "events": [
        "Search Song or Video",
        "Select Song or Video",
        "Play Song or Video"
      ]
    }
  ]
}

リテンション分析

特定の開始および復帰アクションに対するユーザーのリテンションを取得します。

GET https://amplitude.com/api/2/retention

curl --location --request GET 'https://amplitude.com/api/2/retention?se={"event_type":"STARTEVENT"}&re={"event_type":"RETURNEVENT"}&start=STARTDATE&end=ENDDATE' \
-u '{api_key}:{secret_key}'

クエリパラメータ

パラメータ概要
se必須です。 開始アクションのフルイベントです。 新規ユーザ用_newとすべてのユーザ用_activeの2つのevent_type値をサポートしています。
re必須です。 再訪アクションのフルイベントです。1つのevent_type値をサポートしています：すべてのイベントには_all、すべてのアクティブなイベントには_activeです。
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
rmオプションです。リテンションタイプは、bracket、rolling、またはn-dayです。rollingが指定されている場合は、無制限リテンションを意味する点に注意してください。デフォルトはn-dayです。
rbオプションです。rmがbracketに設定されている場合は必須です。 各ブラケットに含まれる日数（[[0,4]]形式）。たとえば、「Day 0～Day 4」のブラケットの場合、このパラメータの値は[[0,5]]になります。
iオプションです。毎日、毎週、毎月のカウントにはそれぞれ1、7、または30のいずれかを指定します。 デフォルトは1です。
sオプションです。セグメントの定義。 デフォルトは「なし」です。セグメント定義を参照してください。
gオプションです。制限：1グループ別基準となるプロパティの名前。デフォルトは「なし」です。Amplitude以外のカスタムユーザープロパティの場合、ユーザープロパティ名の先頭にgp:を付けます。たとえば、countryまたはgp:utm_campaignです。

レスポンス

フィールド概要
series2 つのキーを持つ JSON オブジェクトです。datesは、指定した期間内の各日付に対応する、降順に並んだフォーマット済みの日付文字列の配列です。valuesは、各日付をキーとし、その値としてリテンションデータの配列を持つJSONオブジェクトです。最初の要素（インデックス0）には、そのコホートのユーザー総数が含まれています。後続の要素にはリテンションデータが含まれます。インデックスN+1の要素は、i（日、週、または月）に応じたN期間後のリテンションに対応します。インデックス1はDay 0リテンション、インデックス2はDay 1リテンションを表し、以降も同様です。
countそのインターバル中にリテンションされたユーザーの数。
outofコホート内のユーザーの総数（その日に開始アクションを実行したユーザー）。
incompleteその日のユーザーがリテンションされる（定着する）のに十分な時間が経過したかどうか。
combinedJSONオブジェクト。各値は、すべての日付コホートにわたる集計されたリテンションデータの配列です。最初の要素（インデックス 0）には、ユーザーの合計数が含まれています。その後の要素にはリテンションデータが含まれています。インデックス N+1 の要素は、N 間隔後のリテンションに対応します。インデックス1はDay 0リテンション、インデックス2はDay 1リテンションを表し、以降も同様です。このオブジェクトは、valuesJSONオブジェクト内のすべての日付コホートを重複排除したうえで集計した結果です。
seriesMeta各セグメントに対応するラベルの配列です。
segmentIndexセグメントのインデックス。チャートコントロールパネルの右側モジュールでのセグメントの位置を参照します。
eventIndexイベントのインデックス。左側のモジュールに複数存在する場合にどの戻りイベントが選択されるかを示します。
json
{
    "data": {
        "series": [
            {
                "dates": ["Aug 15", "Aug 14"],
                "values": {
                    "Aug 14": [
                        {"count": 12864, "outof": 12864, "incomplete": false}, {"count": 9061, "outof": 12864, "incomplete": false}, ..., {"count": 1561, "outof": 12864, "incomplete": true}
                    ],
                    "Aug 15": [
                        {"count": 14720, "outof": 14720, "incomplete": false}, {"count": 10249, "outof": 14720, "incomplete": false}, ..., {"count": 1773, "outof": 14720, "incomplete": true}
                    ],
                },
                "combined": [
                    {"count": 27584, "outof": 27584, "retainedSetId": null, "incomplete": false},
                    {"count": 19310, "outof": 27584, "retainedSetId": null, "incomplete": false},
                    ...
                    {"count": 1561, "outof": 12864, "retainedSetId": null, "incomplete": true}
                ]
            },
        "seriesMeta": [
            {"segmentIndex": 0, "eventIndex": 0}
            ]
        ]
    }
}

ユーザーアクティビティ

ユーザーサマリーと、そのユーザーの最新または最も古いイベントを取得します。リクエスト制限を超えると、429エラーが返されます。

GET https://amplitude.com/api/2/useractivity

curl --location --request GET 'https://amplitude.com/api/2/useractivity?user={amplitude_id}'
-u '{api_key}:{secret_key}'

クエリパラメータ

名前概要
user必須です。 ユーザーのAmplitude ID。
offsetオプションです。イベントの返却を開始するための、0から始まるインデックスのオフセット（最新のイベントからのオフセット）。
limitオプションです。返されるイベントの数（最大 1000 個）。 APIは部分的なセッションを避けるために、より多くのイベントを返すことがあります。デフォルトは1000です。
directionオプションです。ユーザーの最初のイベントを含める場合はearliestを、最新のイベントを含める場合はlatestを指定します。デフォルトはlatestです。

レスポンス

レスポンスは次のスキーマを持つJSONオブジェクトです。

属性概要
eventsJSONオブジェクトの配列で、ユーザーが実行したイベントごとにそれぞれ1つずつです。
userDataユーザーとユーザーのプロパティに関する統計情報の合計。
json
{
    "userData": {
        "user_id": "myusername",
        "canonical_amplitude_id": 12345,
        "merged_amplitude_ids": [11111, 22222],
        "num_events": 142,
        "num_sessions": 23,
        "usage_time": 2570259,
        "first_used": "2015-03-14",
        "last_used": "2015-04-22",
        "purchases": 2,
        "revenue": 9.98,
        "platform": "iOS",
        "os": "ios 8.2",
        "version": "3.4.9",
        "device": "Apple iPhone",
        "device_type": "Apple iPhone 6",
        "carrier": "AT&T",
        "country": "United States",
        "region": "California",
        "city": "San Francisco",
        "dma": "San Francisco-Oakland-San Jose, CA",
        "language": "English",
        "start_version": "1.2.3",
        "device_ids": ["some-device", "some-other-device"],
        "last_location": {
            "lat": 37.133,
            "lng": -122.241
        },
        "properties": {
            "gender": "female"
        }
    },
    "events": [...]
}

ユーザー検索

Amplitude ID、デバイスID、ユーザーID、またはユーザーIDプレフィックスでユーザーを検索できます。 リクエスト制限を超えると、429エラーが返されます。

GET https://amplitude.com/api/2/usersearch

curl --location --request GET 'https://amplitude.com/api/2/usersearch?user=USER_ID' \
-u '{api-key}:{secret-key}'

クエリパラメータ

名前概要
user必須です。 Amplitude ID、デバイスID、ユーザーID、またはユーザーIDのプレフィックス。

レスポンス

属性概要
matchesJSON オブジェクトの配列。一致するユーザーごとにそれぞれ 1 つずつ、Amplitude ID とユーザー ID が含まれています。
type結果の取得に使用された一致タイプを示します（Amplitude ID、デバイスID、ユーザーID、またはユーザーIDのプレフィックス）。
json
{
  "matches": [
    {
      "user_id": "myusername",
      "amplitude_id": 12345
    }
  ],
  "type": "match_user_or_device_id"
}

一致するものがなかった場合、応答は次の本文を含む 200 応答を返します。

json
{
  "type": "nomatch",
  "matches": []
}

リアルタイムのアクティブユーザー数

過去2日のアクティブユーザー数を5分単位で取得します。

GET https://amplitude.com/api/2/realtime

curl --location --request GET 'https://amplitude.com/api/2/realtime' \
-u '{api-key}:{secret-key}'

レスポンス

次のスキーマを持つ JSON オブジェクトを返します。

属性概要
xValues現在時刻を起点として、1日内の各時間区間に対応するHH:mm形式の時刻文字列の配列です。
seriesLabels2つのラベルからなる配列：TodayおよびYesterday。
seriesseriesLabelsの順序に対応した、各グループごとに1要素を持つ配列です。各要素は、xValues内の各日付のメトリック値を含む配列です。
json
{
    "data": {
        "xValues": ["15:00", "15:05", "15:10", ... ],
        "seriesLabels": ["Today", "Yesterday"],
        "series": [
            [123, 144, 101, ...],
            [139, 111, 180, ...]
        ]
    }
}

生涯収益価値

新規ユーザーの生涯価値を把握しましょう。

GET https://amplitude.com/api/2/revenue/ltv

レベニューLTVチャートについての詳細はこちらをご覧ください。
curl --location --request GET 'https://amplitude.com/api/2/revenue/ltv?start=&end=' \
-u '{api-key}:{secret-key}'

クエリパラメータ

パラメータ概要
mオプションです。次のメトリクスのいずれかを指定します。0 = ユーザーあたりの平均収益（ARPU）、1 = ユーザーあたりの平均実績収益（ARPPU）、2 = 総収益、3 = 有料ユーザー数デフォルトは 0 です。
start必須です。 データシリーズに含まれる最初の日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
end必須です。 データシリーズに含まれる最終日付。フォーマットはYYYYMMDD。たとえば、20221001のようになります。
iオプションです。毎日、毎週、毎月のカウントにはそれぞれ1、7、または30のいずれかを指定します。 デフォルトは1です。
sオプションです。セグメントの定義。 デフォルトは「なし」です。セグメント定義を参照してください。
gオプションです。制限：1グループ別基準となるプロパティの名前。デフォルトは「なし」です。Amplitude以外のカスタムユーザープロパティの場合、ユーザープロパティ名の先頭にgp:を付けます。たとえば、countryまたはgp:utm_campaignです。

レスポンス

次のスキーマを持つ JSON オブジェクトを含むレスポンスを返します。

フィールド概要
seriesLabelsラベルの配列。各グループに1つずつあります。
series2つのキーを持つJSONオブジェクトです。datesは、指定した期間内の各日付に対応する、降順に並んだフォーマット済みの日付文字列の配列です。valuesは、各日付をキーとして持つJSONオブジェクトです。各値には、n日間のメトリック値を表すr1d、r2d、...、r90dといったキーに加えて、count、paidおよびtotal_amountが含まれます。これらはそれぞれ、グループ内の総ユーザー数、有料ユーザー数、およびユーザーによる支払い総額を示します。
json
{
    "data": {
        "seriesLabels": [""],
        "series": [
            {
                "dates": ["2021-10-04", "2021-10-03", "2021-10-02", "2021-10-01"],
                "values": {
                    "2014-10-01": {
                        "r1d": 9.99,
                        "r2d": 19.98,
                        ...
                        "r90d": 742.52,
                        "count": 110,
                        "paid": 37,
                        "total_amount": 781.39
                    },
                    ...
                }
            }
        ]
    }
}

Was this helpful?