Prerequisites
You need the following before you can call the API:- An Amazon Developer Account with Admin level credentials
- A Security Profile mapped to the Reporting API (created through the Developer Console > My Settings > API Access)
- The Client ID and Client Secret from the profile’s Web Settings tab
- Your app’s package name
How it works
Data flows from raw crash logs and performance telemetry on devices into daily and hourly aggregation tables.- Daily metrics provide one data point per day, available at T-1 day.
- Hourly metrics provide one data point per hour, available at T-2 hours. This is useful for early regression detection after a release.
Freshness
Each metric set offers a standardGET method to retrieve the timestamp of the latest available data, known as freshness. Since a metric set can support multiple granularities (daily, hourly), the operation returns one freshness value per supported granularity.
Data queries
To access the data in a metric set, use thePOST :query method. Each query must specify a granularity and a time range. Together with the metrics you want to access, you can specify dimensions to break down the aggregations or specify filters to narrow results without adding breakdowns.
The results differ depending on whether you do or don’t specify dimensions with your query.
- With dimensions: You get one row per unique dimension combination per time period.
- Without dimensions: You get a single aggregate number per time period
Available metric sets
The table below lists all available metric sets and their supported metrics.| Metric Set | Description | Supported Metrics |
|---|---|---|
crashMetricSet | Crash rate and event counts | crashRate (Decimal): % of distinct users with at least one crash. crashRate7dUserWeighted (Decimal): 7-day user-weighted rolling average. crashRate28dUserWeighted (Decimal): 28-day user-weighted rolling average. userPerceivedCrashRate (Decimal): % of users with crash during foreground use. userPerceivedCrashRate7dUserWeighted (Decimal): 7-day rolling average of foreground crash rate. userPerceivedCrashRate28dUserWeighted (Decimal): 28-day rolling average of foreground crash rate. distinctDevices (Integer): Approximate active device count. crashCount (Integer): Total crash event occurrences. |
anrMetricSet | ANR rate and event counts | Same structure as crash metrics, with anrRate and userPerceivedAnrRate variants, plus distinctDevices and anrCount (Integer): Total ANR event occurrences. |
lmkMetricSet | LMK rate and event counts | Same structure as crash metrics, with lmkRate and userPerceivedLmkRate variants, plus distinctDevices and lmkCount (Integer): Total LMK event occurrences. |
issuesMetricSet | Top crash/ANR issues by frequency | errorEventCount (Integer): Total error events for a crash signature. affectedDeviceCount (Integer): Distinct devices affected. reportText (String): Crash stacktrace or ANR trace. |
Dimensions
Each metric set supports a common set of dimensions for filtering and breakdowns. Unless otherwise specified, all metrics can be broken down or filtered by all available dimensions.Related topics
- Vitals API Reference: Prerequisites, authentication, API endpoints, code examples, error handling, and best practices
- Reporting API: Sales, earnings, and subscription report downloads
- App Health Insights Dashboard: Visual dashboard for the same metrics
- Explore the API: Link to the API Explorer in the Developer Console

