Event Streaming Metrics Summary API

地域

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

リクエストはhttps://amplitude.com（デフォルト）またはhttps://analytics.eu.amplitude.com（EU）に送信されます。https://analytics.amplitude.comホスト名はアナリティクスウェブアプリ（ブラウザーUI）であり、これらのリクエストのAPIベースURLではありません。

考慮事項

• 最新の4時間のデータは、分単位で正確です。それ以外は、1時間ごとに集計されます。4時間より以前のメトリックデータをリクエストする場合は、この点に注意してください。
• Amplitudeは過去90日間のイベントストリーミングメトリックを保持します。このしきい値を超えるstartまたはend時間を送信すると、500ステータスが返されます。

制限事項

APIでは、プロジェクトごとに同時リクエスト数は4件、プロジェクトごとに1分あたりのリクエスト数は12件までに制限されています。Amplitudeは、このしきい値を超えるリクエストを429ステータスコードで拒否します。

リクエスト

必須パラメータとオプションパラメータを指定してGETリクエストをhttps://amplitude.com/api/2/event-streaming/delivery-metrics-summaryに送信します。

次の例は、必要なパラメータのみが含まれるベーシックなリクエストを示しています。

curl --location --request GET 'https://amplitude.com/api/2/event-streaming/delivery-metrics-summary?sync_id=SYNC_ID&time_period=TIME_PERIOD' \
-u '{api_key}:{secret_key}'

クエリパラメータ

レスポンス

レスポンスはJSONオブジェクトで、指定された同期の配信メトリックが含まれます。

{
  "timePeriod": "CUSTOM",
  "eventsDelivered": 19,
  "eventsNotDelivered": 0,
  "deliveryRate": 1.0,
  "latencyInSeconds": 5.098051910578275,
  "timePeriodStart": "2022-10-01 06:00:00.000000",
  "timePeriodEnd": "2022-10-31 06:00:00.000000",
  "successOnFirstAttempt": 19,
  "successAfterRetry": 0,
  "eventsExpired": 0,
  "eventsDiscarded": 0
}

ステータスコード