エクスポート 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ではなく、この表に記載されているホストを使用してください。

考慮事項

• 日付範囲は、イベントデータが Amplitude のサーバーにアップロードされた時刻を指します（server_upload_timeを参照してください）。Export APIは、UTCでタイムスタンプが付いたイベントを返します。データは、サーバーが受信してから2時間以内にエクスポートできるようになります。たとえば、午後8時から9時の間に送信されたデータは、午後9時にロードを開始し、午後11時にエクスポートAPIを通じて利用できるようになります。プラットフォーム上のレポート作成には遅延はありません。 遅延が発生するのはエクスポート処理のみです。
• エクスポート API はプロジェクト横断ビューをサポートしていません。これは、ビューがデータを所有していないためです。 ビュー内のすべてのデータをエクスポートするには、データを取り込んだ基盤となるプロジェクトでExportAPIを呼び出します。
• サイズ制限は4GBです。サイズが4GBを超える場合、リクエストは400レスポンスを返します。この場合、データをエクスポートするにはより小さい時間範囲を選択してください。 1時間分のデータが4GBを超える場合は、Amazon S3エクスポートを使用してください。
• 1日分のデータをエクスポートするには、T00からT23を使用します。例えば、GET 'https://amplitude.com/api/2/export?start=20220101T00&end=20220101T23'のようになります。
• 一度にクエリを実行できる期間の上限は365日です。

リクエスト

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

curl --location --request GET 'https://amplitude.com/api/2/export?start=<starttime>&end=<endtime>' \
-u '{api_key}:{secret_key}'

クエリパラメータ

レスポンス

レスポンスは、JSONファイルを含むZIPアーカイブとして返されます。 データ量によっては、1 時間に複数のファイルが存在する場合があります。 API は、リクエストした時間範囲のデータがない場合に 404 レスポンスを返します。

レスポンススキーマ

レスポンスには、各ファイルの各行に1つのイベント JSON オブジェクトが含まれており、スキーマは以下のとおりです。

{
 "server_received_time": UTC ISO-8601 formatted timestamp,
 "app": int,
 "device_carrier": string,
 "city": string,
 "user_id": string,
 "uuid": UUID,
 "event_time": UTC ISO-8601 formatted timestamp,
 "platform": string,
 "os_version": string,
 "amplitude_id": long,
 "processed_time": UTC ISO-8601 formatted timestamp,
 "version_name": string,
 "ip_address": string,
 "paying": boolean,
 "dma": string,
 "group_properties": dict,
 "user_properties": dict,
 "client_upload_time": UTC ISO-8601 formatted timestamp,
 "$insert_id": string,
 "event_type": string,
 "library": string,
 "amplitude_attribution_ids": string,
 "device_type": string,
 "start_version": string,
 "location_lng": float,
 "server_upload_time": UTC ISO-8601 formatted timestamp,
 "event_id": int,
 "location_lat": float,
 "os_name": string,
 "groups": dict,
 "event_properties": dict,
 "data": dict,
 "device_id": string,
 "language": string,
 "country": string,
 "region": string,
 "session_id": long,
 "device_family": string,
 "sample_rate": null,
 "client_event_time": UTC ISO-8601 formatted timestamp,
}

ステータスコード