get_metrics
Retrieve key app metrics like daily users, sessions, events, and average duration over a chosen period, with filters and previous-period comparison.
Instructions
Key metrics for an app over a period: daily users, sessions, events, avg duration. Includes previous-period comparison when a date range is set.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes | Aptabase app id (from list_apps) | |
| osName | No | Filter by OS name (e.g. iOS, Android, macOS) | |
| period | No | Dashboard period preset. Prefer this over startDate/endDate. Defaults to 24h for stats tools when neither period nor dates are set. | |
| endDate | No | ISO end datetime (use with startDate if not using period) | |
| buildMode | No | Release or debug build mode (debug queries appId_DEBUG) | release |
| eventName | No | Filter by event name | |
| startDate | No | ISO start datetime (use with endDate if not using period) | |
| appVersion | No | Filter by app version | |
| countryCode | No | Filter by ISO country code | |
| deviceModel | No | Filter by device model | |
| granularity | No | Override bucket size; auto-derived from period/range when omitted |