get_top_events
Retrieve top event names ranked by total event count for a specified period, with optional filters (OS, app version, country) to uncover user behavior.
Instructions
Top event names by total event count for the period.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"appId": "<appId>"
},
"name": "get_top_events"
}
}Input 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 |