get_retention_report
Show a retention report
Returns one entry in cohorts per first-seen day, newest first. A cohort is the players whose first activity fell on that UTC day. activity sets what makes a player active on a day: kinds lists which of matches, progression_events, and events count, and event_names limits events to those event names (empty means every event counts). Each cohort has its new players and the share of them active again exactly 1, 7, and 30 days later. A retention value is null until that day has finished. average_retention averages each day over every cohort with a finished value, weighted by cohort size. daily_active_players, weekly_active_players, monthly_active_players, and stickiness have one entry for each finished day from the first activity in the range. Weekly and monthly active players on a day are the players active in the 7 and 30 days ending that day, and stickiness is daily active players divided by monthly active players (null when there are none). averages averages each of the four over those days. Without date filters, the report covers cohorts from the last 90 days.
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": {
"id": "<id>"
},
"name": "get_retention_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The report ID. | |
| occurred_after | No | Only include cohorts from the last N days. Allowed values: 1, 7, 30. Takes precedence over the start of `occurred_between`. | |
| occurred_between | No | Two ISO dates (from, to) that limit the cohorts and active player days to that range. Leave either blank for an open range. |