Vitals APIの概要
Vitals APIを使用すると、Fire TVおよびFireタブレット対応アプリのクラッシュ発生率、アプリ応答なし(ANR)発生率、ローメモリキラー(LMK)発生率などのアプリ健全性指標にプログラムでアクセスできます。これらの指標は指標セットにまとめられています。指標セットは、共通の属性(鮮度と詳細度)を共有し、まとめてクエリできる関連指標を論理的にグループ化したものです。各指標セットは、結果を絞り込んだり、内訳を作成したりするために使用できるディメンションをサポートしています。
Vitals APIの使用にあたっては、Program Materials License Agreementが適用されます。
前提条件
このAPIを呼び出すために必要なものは、次のとおりです。
- 管理者レベルの認証情報を持つAmazon開発者アカウント
- Reporting APIにマッピングされたセキュリティプロファイル(開発者コンソール > [設定] > [APIアクセス] で作成)
- プロファイルの [ウェブ設定] タブにあるクライアントIDとクライアントシークレット
- アプリのパッケージ名
しくみ
データは、デバイス上の未加工のクラッシュログとパフォーマンステレメトリから、日次および時間単位の集計テーブルに送られます。
- 日次指標では、1日に1つのデータポイントが提供され、T-1日に利用できます。
- 時間単位の指標では、1時間あたり1つのデータポイントが提供され、T-2 時間に利用できます。これは、リリース後の早期リグレッション検出に役立ちます。
鮮度
各メトリックセットには、利用可能な最新のデータのタイムスタンプ(鮮度と呼ばれる)を取得するための標準のGETメソッドが用意されています。指標セットは複数の詳細度(日次、時間単位)をサポートできるため、オペレーションでは、サポートされている詳細度ごとに1つの鮮度値が返されます。
| 集計期間 | 鮮度SLA | リテンション | 最大クエリ範囲 |
|---|---|---|---|
| 毎日 | T-1日 | 30日間 | 1回のリクエストにつき30日間 |
| 毎時 | T-2時間 | 15日間 | 1回のリクエストにつき15日間 |
クエリを実行する前に、どの日付範囲でデータが返されるかを常に確認する必要があります。
データクエリ
指標セットのデータにアクセスするには、POST :queryメソッドを使用します。各クエリでは、詳細度と時間範囲を指定する必要があります。アクセスする指標と共に、ディメンションを指定して集計結果の内訳を示したり、フィルターを指定して内訳を追加せずに結果を絞り込んだりできます。
結果は、クエリでディメンションを指定するかどうかによって異なります。
- ディメンションの指定あり: 期間ごと、一意のディメンションの組み合わせごとに1行が返されます。
- ディメンションの指定なし: 期間ごとに1つの集計値が返されます。
使用可能な指標セット
以下の表は、使用可能なすべての指標セットとサポートされている指標の一覧です。
DAILYの詳細度でのみ利用できます。distinctDevices指標はおよその数であり、複数の期間にわたって合計しないでください。回数指標(crashCount、anrCount、lmkCount)は、エラーイベントの発生回数の合計(1台のデバイスが5回クラッシュした場合 = 5回)を表します。| 指標セット | 説明 | サポートされている指標 |
|---|---|---|
crashMetricSet |
クラッシュ発生率とイベント数 | crashRate(10進数):1回以上クラッシュした個別ユーザーの割合(%)。 crashRate7dUserWeighted(10進数): 7日間のユーザー加重移動平均。 crashRate28dUserWeighted(10進数): 28日間のユーザー加重移動平均。 userPerceivedCrashRate(10進数):フォアグラウンド使用中にクラッシュしたユーザーの割合(%)。 userPerceivedCrashRate7dUserWeighted(10進数): フォアグラウンドクラッシュ発生率の7日間の移動平均。 userPerceivedCrashRate28dUserWeighted(10進数): フォアグラウンドクラッシュ発生率の28日間の移動平均。 distinctDevices(整数): およそのアクティブデバイス数。 crashCount(整数): クラッシュイベントの総発生回数。 |
anrMetricSet |
ANR発生率とイベント数 | クラッシュ指標と同じ構造で、anrRateとuserPerceivedAnrRateのバリアントに加えて、distinctDevicesとanrCount(整数): ANRイベントの総発生回数があります。 |
lmkMetricSet |
LMK発生率とイベント数 | クラッシュ指標と同じ構造で、lmkRateとuserPerceivedLmkRateのバリアントに加えて、distinctDevicesとlmkCount(整数): LMKイベントの総発生回数。 |
issuesMetricSet |
上位頻度のクラッシュ/ANRの問題 | errorEventCount(整数): クラッシュシグニチャのエラーイベントの総数。 affectedDeviceCount(整数): 影響を受けた個別のデバイスの数。 reportText(文字列): クラッシュスタックトレースまたはANRトレース。 |
crashRateは、正規化された発生率(クラッシュしたデバイス/アクティブなデバイス)を表します。crashCountは、期間中に発生したクラッシュイベントの絶対数です。バージョンまたはデバイス間で傾向を比較する場合は、発生率を使用します。未加工の数量が必要な場合は、カウントを使用します。issuesMetricSetは、リクエストされた時間範囲全体を集計し、一意のクラッシュシグニチャごとに1行を返して、それらの行をerrorEventCountの降順で並べ替えます(影響の最も大きい問題が先頭になります)。エラータイプ(CRASHまたはANR)を指定するreportTypeパラメーターが必要です。各行には、クラッシュスタックトレースが利用可能であれば含まれます。この指標セットは、ドリルダウン調査用に設計されています。発生率指標セットに見られる発生率急上昇が、どのクラッシュシグニチャによって引き起こされているかを特定します。LMKはサポートされません。LMKイベントはシステムによってトリガーされ、デバッグできるスタックトレースがないためです。ディメンション
各指標セットは、絞り込みと内訳表示のための共通のディメンションセットをサポートしています。特に指定がない限り、すべての指標は利用可能なすべてのディメンションで内訳表示または絞り込みが可能です。
| ディメンション | 型 | 説明 |
|---|---|---|
versionCode |
int64 | データが取得された時点で、ユーザーのデバイスで実行されていたアプリのバージョンコード。 |
countryCode |
string | ユーザーの所在地に基づく、2文字のISO-3166国コード(例:US)。 |
deviceModel |
string | デバイスモデルの通称(AFTSS、AFTSSSなど)。 |
deviceType |
string | デバイスのフォームファクター: AMAZON_FIRE_TVまたはAMAZON_TABLETS。 |
deviceOS |
string | デバイスのOSの種類: FIRE_OSまたはVEGA_OS。 |
osVersion |
string | OSのバージョン(RS8401/2542など)。 |
関連トピック
- Vitals APIリファレンス: 前提条件、認証、APIエンドポイント、コード例、エラー処理、ベストプラクティス
- Reporting API: 売上、収益、定期購入レポートのダウンロード
- アプリ健全性インサイトダッシュボード: 同じ指標の視覚的なダッシュボード
Last updated: 2026年6月29日

